DP_Reference_3b - Healthcare Financial Services IG Edition 1 v0.3.0

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: DP_Reference_3b

Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-3b				Version: 0.3.0
Draft as of 2025-06-23				Computable Name: DP_Reference_3b

Used when providing the business identifier for a resource when there is a choice of valid resource types, e.g. Reference(Claim or EligibilityRequest)

Usage:

This DataType Constraint is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Reference

Name	Card.	Type	Description & Constraints
Reference	0..*	Reference	A reference from one resource to another
type	1..1	DP_uri	Type the reference refers to (e.g. "Patient")
identifier	1..1	DP_Identifier_A	Logical reference, when literal reference is not known
type	0..1	DP_CodeableConcept	Description of identifier
display	0..1	string	Text alternative for the resource Max Length:200
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children
identifier	Σ	1..1	DP_Identifier_A	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	DP_CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	DP_uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Max Length:50
display	Σ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Reference.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Reference.identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ref-1	error	Reference	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	DP_Identifier_A	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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)
display	Σ	0..1	string	Text alternative for the resource Max Length:200
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Reference.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Reference.identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ref-1	error	Reference	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Reference

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Reference

Name	Card.	Type	Description & Constraints
Reference	0..*	Reference	A reference from one resource to another
type	1..1	DP_uri	Type the reference refers to (e.g. "Patient")
identifier	1..1	DP_Identifier_A	Logical reference, when literal reference is not known
type	0..1	DP_CodeableConcept	Description of identifier
display	0..1	string	Text alternative for the resource Max Length:200
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children
identifier	Σ	1..1	DP_Identifier_A	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	DP_CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	DP_uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 Max Length:50
display	Σ	0..1	string	Text alternative for the resource ele-1: All FHIR elements must have a @value or children Max Length:200
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Reference.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Reference.identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ref-1	error	Reference	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	1..1	DP_Identifier_A	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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)
display	Σ	0..1	string	Text alternative for the resource Max Length:200
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Reference.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Reference.identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ref-1	error	Reference	SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from Reference

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Other representations of profile: CSV, Excel, Schematron