Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ICR Referral

Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRReferral Version: 0.1.0
Draft as of 2026-10-29 Computable Name: ICRReferral

A referral of a person from campaign work to a facility or provider: an adverse event after a dose, fever or suspected malaria during SMC, acute malnutrition, a child excluded for illness, a zero-dose child sent to routine immunization, a pregnant woman excluded from MDA and sent to antenatal care. The receiving facility's follow-up is an ICRReferralFulfilment whose focus is this request. A referral the facility recorded with no field referral (for example a DIGIT HFReferral) is also an ICRReferral, with requester absent and an identifier carrying the facility record's id.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... 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
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... status ?!SΣ 1..1 code active when made → completed when a fulfilment completes; revoked when withdrawn by the referring programme, merged into another referral, or closed at the end of the follow-up period (with a note). A failed fulfilment does not revoke it
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... category SΣ 1..1 CodeableConcept Fixed: campaign-referral
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code urgent for an emergency referral, otherwise routine
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... subject SΣ 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... occurrence[x] SΣ 0..1 The scheduled appointment, where given
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 1..1 dateTime When the referral was made
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performer SΣ 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationReference SΣ 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode SΣ 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... note S 0..* Annotation Referral notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... identifier 0..* Identifier Source record ids, for example the facility referral id when the request was created from a facility record
... basedOn S 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category S 1..1 CodeableConcept Fixed: campaign-referral
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
... priority S 0..1 code urgent for an emergency referral, otherwise routine
... subject S 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... occurrence[x] S 0..1 dateTime, Period, Timing The scheduled appointment, where given
... authoredOn S 1..1 dateTime When the referral was made
... requester S 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performer S 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationReference S 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode S 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... note S 0..* Annotation Referral notes

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Source record ids, for example the facility referral id when the request was created from a facility record
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code active when made → completed when a fulfilment completes; revoked when withdrawn by the referring programme, merged into another referral, or closed at the end of the follow-up period (with a note). A failed fulfilment does not revoke it
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... category SΣ 1..1 CodeableConcept Fixed: campaign-referral
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code urgent for an emergency referral, otherwise routine
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code Σ 0..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... occurrence[x] SΣ 0..1 The scheduled appointment, where given
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣ 1..1 dateTime When the referral was made
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer SΣ 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... locationReference SΣ 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode SΣ 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* Annotation Referral notes
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... 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
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... status ?!SΣ 1..1 code active when made → completed when a fulfilment completes; revoked when withdrawn by the referring programme, merged into another referral, or closed at the end of the follow-up period (with a note). A failed fulfilment does not revoke it
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... category SΣ 1..1 CodeableConcept Fixed: campaign-referral
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code urgent for an emergency referral, otherwise routine
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... subject SΣ 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... occurrence[x] SΣ 0..1 The scheduled appointment, where given
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 1..1 dateTime When the referral was made
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performer SΣ 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationReference SΣ 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode SΣ 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... note S 0..* Annotation Referral notes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequest A request for a service to be performed
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... identifier 0..* Identifier Source record ids, for example the facility referral id when the request was created from a facility record
... basedOn S 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... intent 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
... category S 1..1 CodeableConcept Fixed: campaign-referral
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
... priority S 0..1 code urgent for an emergency referral, otherwise routine
... subject S 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... occurrence[x] S 0..1 dateTime, Period, Timing The scheduled appointment, where given
... authoredOn S 1..1 dateTime When the referral was made
... requester S 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performer S 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationReference S 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode S 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... note S 0..* Annotation Referral notes

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
Constraints: prr-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:referringTask S 0..1 Reference(ICR Campaign Task) The campaign visit (ICRCampaignTask) at which the referral was made
URL: https://icr.healthcampaigns.org/StructureDefinition/referring-task
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Source record ids, for example the facility referral id when the request was created from a facility record
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 1..1 Reference(ICR Campaign) The campaign (round) in which the referral was made
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code active when made → completed when a fulfilment completes; revoked when withdrawn by the referring programme, merged into another referral, or closed at the end of the follow-up period (with a note). A failed fulfilment does not revoke it
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
Required Pattern: order
... category SΣ 1..1 CodeableConcept Fixed: campaign-referral
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.

Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: https://icr.healthcampaigns.org/CodeSystem/icr-referral-category-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: campaign-referral
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code urgent for an emergency referral, otherwise routine
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code Σ 0..1 CodeableConcept What is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred.
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(ICR Patient (Beneficiary / Registered Individual)) The person referred
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... occurrence[x] SΣ 0..1 The scheduled appointment, where given
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣ 1..1 dateTime When the referral was made
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole) The referring worker (and, through PractitionerRole, their facility). Absent on a referral created from a facility record
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer SΣ 0..* Reference(ICR Facility Organization | Organization | PractitionerRole | Practitioner) Whom the person is referred to: the receiving facility's Organization, or a named provider (PractitionerRole where one exists, otherwise Practitioner). A Location is not a legal performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
... locationReference SΣ 0..* Reference(ICR Location) The receiving facility's Location: where the person is to go
... reasonCode SΣ 1..* CodeableConcept Why the person was referred (ICR codes, mapped to SNOMED CT by ConceptMap icr-referral-reason-to-snomed)
Binding: ICR Referral Reason (extensible)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo S 0..* Reference(ICR Adverse Event | ICR Medication Administration | ICR Immunization Event) The adverse event that caused the referral, and any treatment given before referral. R4 reasonReference cannot reference an AdverseEvent
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... note S 0..* Annotation Referral notes
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ServiceRequest.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ServiceRequest.status Base required RequestStatus 📍4.0.1 FHIR Std.
ServiceRequest.intent Base required RequestIntent 📍4.0.1 FHIR Std.
ServiceRequest.category Base example Service Request Category Codes 📍4.0.1 FHIR Std.
ServiceRequest.priority Base required Request priority 📍4.0.1 FHIR Std.
ServiceRequest.code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
ServiceRequest.orderDetail Base example Service Request Order Details Codes 📍4.0.1 FHIR Std.
ServiceRequest.asNeeded[x] Base example SNOMED CT Medication As Needed Reason Codes 📍4.0.1 FHIR Std.
ServiceRequest.performerType Base example Participant Roles 📍4.0.1 FHIR Std.
ServiceRequest.locationCode Base example ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.5
ServiceRequest.reasonCode Base extensible ICR Referral Reason 📦0.1.0 This IG
ServiceRequest.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron