Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-CommunicationRequest | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_CommunicationRequest_R4B | ||
This cross-version profile allows STU3 CommunicationRequest content to be represented via FHIR R4B CommunicationRequest resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CommunicationRequest |
0..* | CommunicationRequest(4.3.0) | A request for information to be sent to a receiver | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:topic |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) | STU3: Focal resources (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.topic Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
 doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | CommunicationRequest.implicitRules, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.status, CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CommunicationRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest(4.3.0) | A request for information to be sent to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:topic |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) | STU3: Focal resources (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.topic Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Unique identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: basedOn additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:groupIdentifier |
0..1 | Identifier | STU3: groupIdentifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.groupIdentifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
| category |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
0..1 | Reference(Patient | Group) | Focus of message | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: Encounter or episode leading to message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| payload |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:content |
0..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.payload.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
  content[x] |
1..1 | Message part content | ||||||
  content[x]All Types |
Content/Rules for all Types | |||||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: content additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| occurrence[x] |
Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:agent |
1..1 | Reference(Resource) | STU3: Individual making the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization agent is acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.requester.onBehalfOf Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| recipient |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:recipient |
0..1 | Reference(Resource) | STU3: recipient URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| sender |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:sender |
0..1 | Reference(Resource) | STU3: sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: reasonReference additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.replaces.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.groupIdentifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.groupIdentifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.1 |
| CommunicationRequest.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.requester.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.recipient.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.sender.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.1 |
| CommunicationRequest.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | CommunicationRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | CommunicationRequest.meta, CommunicationRequest.meta.extension, CommunicationRequest.meta.extension:meta, CommunicationRequest.meta.versionId, CommunicationRequest.meta.lastUpdated, CommunicationRequest.meta.source, CommunicationRequest.meta.profile, CommunicationRequest.meta.security, CommunicationRequest.meta.tag, CommunicationRequest.implicitRules, CommunicationRequest.language, CommunicationRequest.text, CommunicationRequest.text.extension, CommunicationRequest.text.extension:text, CommunicationRequest.text.status, CommunicationRequest.text.div, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.identifier, CommunicationRequest.identifier.extension, CommunicationRequest.identifier.extension:identifier, CommunicationRequest.identifier.use, CommunicationRequest.identifier.type, CommunicationRequest.identifier.system, CommunicationRequest.identifier.value, CommunicationRequest.identifier.period, CommunicationRequest.identifier.assigner, CommunicationRequest.basedOn, CommunicationRequest.basedOn.extension, CommunicationRequest.basedOn.extension:basedOn, CommunicationRequest.basedOn.reference, CommunicationRequest.basedOn.type, CommunicationRequest.basedOn.identifier, CommunicationRequest.basedOn.display, CommunicationRequest.replaces, CommunicationRequest.replaces.extension, CommunicationRequest.replaces.extension:replaces, CommunicationRequest.replaces.reference, CommunicationRequest.replaces.type, CommunicationRequest.replaces.identifier, CommunicationRequest.replaces.display, CommunicationRequest.groupIdentifier, CommunicationRequest.groupIdentifier.extension, CommunicationRequest.groupIdentifier.extension:groupIdentifier, CommunicationRequest.groupIdentifier.use, CommunicationRequest.groupIdentifier.type, CommunicationRequest.groupIdentifier.system, CommunicationRequest.groupIdentifier.value, CommunicationRequest.groupIdentifier.period, CommunicationRequest.groupIdentifier.assigner, CommunicationRequest.status, CommunicationRequest.statusReason, CommunicationRequest.category, CommunicationRequest.priority, CommunicationRequest.doNotPerform, CommunicationRequest.medium, CommunicationRequest.subject, CommunicationRequest.subject.extension, CommunicationRequest.subject.extension:subject, CommunicationRequest.subject.reference, CommunicationRequest.subject.type, CommunicationRequest.subject.identifier, CommunicationRequest.subject.display, CommunicationRequest.about, CommunicationRequest.encounter, CommunicationRequest.encounter.extension, CommunicationRequest.encounter.extension:context, CommunicationRequest.encounter.reference, CommunicationRequest.encounter.type, CommunicationRequest.encounter.identifier, CommunicationRequest.encounter.display, CommunicationRequest.payload, CommunicationRequest.payload.extension, CommunicationRequest.payload.extension:content, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x], CommunicationRequest.payload.content[x].extension, CommunicationRequest.payload.content[x].extension:alternateReference, CommunicationRequest.occurrence[x], CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.requester.extension, CommunicationRequest.requester.extension:agent, CommunicationRequest.requester.extension:onBehalfOf, CommunicationRequest.requester.reference, CommunicationRequest.requester.type, CommunicationRequest.requester.identifier, CommunicationRequest.requester.display, CommunicationRequest.recipient, CommunicationRequest.recipient.extension, CommunicationRequest.recipient.extension:recipient, CommunicationRequest.recipient.reference, CommunicationRequest.recipient.type, CommunicationRequest.recipient.identifier, CommunicationRequest.recipient.display, CommunicationRequest.sender, CommunicationRequest.sender.extension, CommunicationRequest.sender.extension:sender, CommunicationRequest.sender.reference, CommunicationRequest.sender.type, CommunicationRequest.sender.identifier, CommunicationRequest.sender.display, CommunicationRequest.reasonCode, CommunicationRequest.reasonReference, CommunicationRequest.reasonReference.extension, CommunicationRequest.reasonReference.extension:reasonReference, CommunicationRequest.reasonReference.reference, CommunicationRequest.reasonReference.type, CommunicationRequest.reasonReference.identifier, CommunicationRequest.reasonReference.display, CommunicationRequest.note, CommunicationRequest.note.extension, CommunicationRequest.note.extension:note, CommunicationRequest.note.author[x], CommunicationRequest.note.time, CommunicationRequest.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CommunicationRequest.meta.extension, CommunicationRequest.meta.extension:meta, CommunicationRequest.text.extension, CommunicationRequest.text.extension:text, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.identifier.extension, CommunicationRequest.identifier.extension:identifier, CommunicationRequest.basedOn.extension, CommunicationRequest.basedOn.extension:basedOn, CommunicationRequest.replaces.extension, CommunicationRequest.replaces.extension:replaces, CommunicationRequest.groupIdentifier.extension, CommunicationRequest.groupIdentifier.extension:groupIdentifier, CommunicationRequest.subject.extension, CommunicationRequest.subject.extension:subject, CommunicationRequest.encounter.extension, CommunicationRequest.encounter.extension:context, CommunicationRequest.payload.extension, CommunicationRequest.payload.extension:content, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x].extension, CommunicationRequest.payload.content[x].extension:alternateReference, CommunicationRequest.requester.extension, CommunicationRequest.requester.extension:agent, CommunicationRequest.requester.extension:onBehalfOf, CommunicationRequest.recipient.extension, CommunicationRequest.recipient.extension:recipient, CommunicationRequest.sender.extension, CommunicationRequest.sender.extension:sender, CommunicationRequest.reasonReference.extension, CommunicationRequest.reasonReference.extension:reasonReference, CommunicationRequest.note.extension, CommunicationRequest.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | CommunicationRequest.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | CommunicationRequest.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from CommunicationRequest
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest(4.3.0) | A request for information to be sent to a receiver | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:topic |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) | STU3: Focal resources (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.topic Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | CommunicationRequest.implicitRules, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.status, CommunicationRequest.doNotPerform | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from CommunicationRequest
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CommunicationRequest |
0..* | CommunicationRequest(4.3.0) | A request for information to be sent to a receiver | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:topic |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R4B(0.1.0) | Resource) | STU3: Focal resources (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.topic Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
Σ | 0..* | Identifier | Unique identifier | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: basedOn additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:groupIdentifier |
0..1 | Identifier | STU3: groupIdentifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.groupIdentifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request. | |||||
| category |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
| priority |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
| medium |
0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc. | |||||
| subject |
0..1 | Reference(Patient | Group) | Focus of message | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: subject additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:context |
0..1 | Reference(Resource) | STU3: Encounter or episode leading to message additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| payload |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:content |
0..1 | Attachment | STU3: content additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.payload.content Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| content[x] |
1..1 | Message part content | ||||||
| content[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | STU3: content additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| occurrence[x] |
Σ | 0..1 | When scheduled | |||||
| occurrenceDateTime |
dateTime | |||||||
| occurrencePeriod |
Period | |||||||
| authoredOn |
Σ | 0..1 | dateTime | When request transitioned to being actionable | ||||
| requester |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:agent |
1..1 | Reference(Resource) | STU3: Individual making the request URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| extension:onBehalfOf |
0..1 | Reference(Cross-version Profile for STU3.Organization for use in FHIR R4B(0.1.0) | Organization) | STU3: Organization agent is acting for (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.requester.onBehalfOf Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| recipient |
0..* | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | Group | CareTeam | HealthcareService) | Message recipient | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:recipient |
0..1 | Reference(Resource) | STU3: recipient URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| sender |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:sender |
0..1 | Reference(Resource) | STU3: sender URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. | ||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reasonReference |
0..1 | Reference(Resource) | STU3: reasonReference additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments made about communication request | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CommunicationRequest.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CommunicationRequest.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.basedOn.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.replaces.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.groupIdentifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.groupIdentifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.status | Base | required | RequestStatus | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.statusReason | Base | example | Not State | Unknown | |
| CommunicationRequest.category | Base | example | CommunicationCategory | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.priority | Base | required | RequestPriority | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.1 |
| CommunicationRequest.subject.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.encounter.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.requester.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.recipient.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.sender.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| CommunicationRequest.reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.1 |
| CommunicationRequest.reasonReference.type | Base | extensible | ResourceType | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | CommunicationRequest | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | CommunicationRequest | If 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-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | CommunicationRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | CommunicationRequest.meta, CommunicationRequest.meta.extension, CommunicationRequest.meta.extension:meta, CommunicationRequest.meta.versionId, CommunicationRequest.meta.lastUpdated, CommunicationRequest.meta.source, CommunicationRequest.meta.profile, CommunicationRequest.meta.security, CommunicationRequest.meta.tag, CommunicationRequest.implicitRules, CommunicationRequest.language, CommunicationRequest.text, CommunicationRequest.text.extension, CommunicationRequest.text.extension:text, CommunicationRequest.text.status, CommunicationRequest.text.div, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.identifier, CommunicationRequest.identifier.extension, CommunicationRequest.identifier.extension:identifier, CommunicationRequest.identifier.use, CommunicationRequest.identifier.type, CommunicationRequest.identifier.system, CommunicationRequest.identifier.value, CommunicationRequest.identifier.period, CommunicationRequest.identifier.assigner, CommunicationRequest.basedOn, CommunicationRequest.basedOn.extension, CommunicationRequest.basedOn.extension:basedOn, CommunicationRequest.basedOn.reference, CommunicationRequest.basedOn.type, CommunicationRequest.basedOn.identifier, CommunicationRequest.basedOn.display, CommunicationRequest.replaces, CommunicationRequest.replaces.extension, CommunicationRequest.replaces.extension:replaces, CommunicationRequest.replaces.reference, CommunicationRequest.replaces.type, CommunicationRequest.replaces.identifier, CommunicationRequest.replaces.display, CommunicationRequest.groupIdentifier, CommunicationRequest.groupIdentifier.extension, CommunicationRequest.groupIdentifier.extension:groupIdentifier, CommunicationRequest.groupIdentifier.use, CommunicationRequest.groupIdentifier.type, CommunicationRequest.groupIdentifier.system, CommunicationRequest.groupIdentifier.value, CommunicationRequest.groupIdentifier.period, CommunicationRequest.groupIdentifier.assigner, CommunicationRequest.status, CommunicationRequest.statusReason, CommunicationRequest.category, CommunicationRequest.priority, CommunicationRequest.doNotPerform, CommunicationRequest.medium, CommunicationRequest.subject, CommunicationRequest.subject.extension, CommunicationRequest.subject.extension:subject, CommunicationRequest.subject.reference, CommunicationRequest.subject.type, CommunicationRequest.subject.identifier, CommunicationRequest.subject.display, CommunicationRequest.about, CommunicationRequest.encounter, CommunicationRequest.encounter.extension, CommunicationRequest.encounter.extension:context, CommunicationRequest.encounter.reference, CommunicationRequest.encounter.type, CommunicationRequest.encounter.identifier, CommunicationRequest.encounter.display, CommunicationRequest.payload, CommunicationRequest.payload.extension, CommunicationRequest.payload.extension:content, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x], CommunicationRequest.payload.content[x].extension, CommunicationRequest.payload.content[x].extension:alternateReference, CommunicationRequest.occurrence[x], CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.requester.extension, CommunicationRequest.requester.extension:agent, CommunicationRequest.requester.extension:onBehalfOf, CommunicationRequest.requester.reference, CommunicationRequest.requester.type, CommunicationRequest.requester.identifier, CommunicationRequest.requester.display, CommunicationRequest.recipient, CommunicationRequest.recipient.extension, CommunicationRequest.recipient.extension:recipient, CommunicationRequest.recipient.reference, CommunicationRequest.recipient.type, CommunicationRequest.recipient.identifier, CommunicationRequest.recipient.display, CommunicationRequest.sender, CommunicationRequest.sender.extension, CommunicationRequest.sender.extension:sender, CommunicationRequest.sender.reference, CommunicationRequest.sender.type, CommunicationRequest.sender.identifier, CommunicationRequest.sender.display, CommunicationRequest.reasonCode, CommunicationRequest.reasonReference, CommunicationRequest.reasonReference.extension, CommunicationRequest.reasonReference.extension:reasonReference, CommunicationRequest.reasonReference.reference, CommunicationRequest.reasonReference.type, CommunicationRequest.reasonReference.identifier, CommunicationRequest.reasonReference.display, CommunicationRequest.note, CommunicationRequest.note.extension, CommunicationRequest.note.extension:note, CommunicationRequest.note.author[x], CommunicationRequest.note.time, CommunicationRequest.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CommunicationRequest.meta.extension, CommunicationRequest.meta.extension:meta, CommunicationRequest.text.extension, CommunicationRequest.text.extension:text, CommunicationRequest.extension, CommunicationRequest.extension:topic, CommunicationRequest.modifierExtension, CommunicationRequest.identifier.extension, CommunicationRequest.identifier.extension:identifier, CommunicationRequest.basedOn.extension, CommunicationRequest.basedOn.extension:basedOn, CommunicationRequest.replaces.extension, CommunicationRequest.replaces.extension:replaces, CommunicationRequest.groupIdentifier.extension, CommunicationRequest.groupIdentifier.extension:groupIdentifier, CommunicationRequest.subject.extension, CommunicationRequest.subject.extension:subject, CommunicationRequest.encounter.extension, CommunicationRequest.encounter.extension:context, CommunicationRequest.payload.extension, CommunicationRequest.payload.extension:content, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x].extension, CommunicationRequest.payload.content[x].extension:alternateReference, CommunicationRequest.requester.extension, CommunicationRequest.requester.extension:agent, CommunicationRequest.requester.extension:onBehalfOf, CommunicationRequest.recipient.extension, CommunicationRequest.recipient.extension:recipient, CommunicationRequest.sender.extension, CommunicationRequest.sender.extension:sender, CommunicationRequest.reasonReference.extension, CommunicationRequest.reasonReference.extension:reasonReference, CommunicationRequest.note.extension, CommunicationRequest.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | CommunicationRequest.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | CommunicationRequest.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from CommunicationRequest
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
Slices for extension