Healthcare Financial Services IG Edition 1
0.4.0 - STU-Ballot with Updates Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.4.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.4.0
Draft as of 2025-10-12 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)

Usages:

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

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
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... 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
.... 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
... display Σ 0..1 string Text alternative for the resource
Max Length:200

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Reference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Reference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'))

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... 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
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Reference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Reference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... 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
.... 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
... display Σ 0..1 string Text alternative for the resource
Max Length:200

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Reference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Reference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'))

Differential View

This structure is derived from Reference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Reference C 0..* Reference A reference from one resource to another
Constraints: ref-1
... 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
... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Reference.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Reference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Reference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'))

 

Other representations of profile: CSV, Excel, Schematron