Requirement Specification

This is for collaboration and discussion purposes and is subject to change.

This is not an Implementation Guide

Radiology (Sandbox) - Local Development build (v0.0.1-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: Reference - RESTful or Logical

A Reference data type where the referenced resource could be resolvable RESTfully or pointed to logically.

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	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
reference	SC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SC	0..1	Identifier	Logical reference, when literal reference is not known
system		0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	S	1..1	string	The value that is unique
display	SC	0..1	string	Text alternative for the resource
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

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 PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SΣC	0..1	Identifier	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 .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣC	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

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 PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
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	SΣ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): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣC	0..1	Identifier	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	Σ	0..1	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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..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)
display	SΣC	0..1	string	Text alternative for the resource
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
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

This structure is derived from Reference

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 4 elements

Differential View

This structure is derived from Reference

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
reference	SC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SC	0..1	Identifier	Logical reference, when literal reference is not known
system		0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	S	1..1	string	The value that is unique
display	SC	0..1	string	Text alternative for the resource
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

Key Elements 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 PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL
identifier	SΣC	0..1	Identifier	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 .
system	Σ	0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..1	string	The value that is unique Example General: 123456
display	SΣC	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Reference.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

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 PA-ident-1: reference or identifier must be present PA-ident-2: If reference is not present, display must be present
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	SΣ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): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣC	0..1	Identifier	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	Σ	0..1	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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-npi
value	SΣ	1..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)
display	SΣC	0..1	string	Text alternative for the resource
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
PA-ident-1	error	Reference	reference or identifier must be present : reference.exists() or identifier.exists()
PA-ident-2	error	Reference	If reference is not present, display must be present : reference.exists().not() implies display.exists()

This structure is derived from Reference

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 4 elements

Other representations of profile: CSV, Excel, Schematron