This page is part of the U.S. Physical Activity IG (v1.0.0-ballot: STU 1.0 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: Reference - RESTful

A Reference data type where the referenced resource is expected to be resolvable RESTfully.

Usage:

• Use this DataType Constraint: PA Condition - Low Physical Activity, PA Intervention Report, PA-Related Goal, PA Observation Activity Group... Show 10 more, PA Observation - Activity-based, PA Base Observation, PA Vital Sign Days per Week, PA Vital Sign Minutes per Day, PA Vital Sign Minutes per Week, PA Vital Sign Observation, PA Strength Days Week, PA Measure - Time-based, PA Service Request and PA Task for Referral Management

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		0..*	Reference	A reference from one resource to another
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
display	S	0..1	string	Text alternative for the resource
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

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
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	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Reference.type	extensible	ResourceType

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()

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 2 elements

Differential View

This structure is derived from Reference

Name	Flags	Card.	Type	Description & Constraints
Reference		0..*	Reference	A reference from one resource to another
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
display	S	0..1	string	Text alternative for the resource
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Reference	C	0..*	Reference	A reference from one resource to another
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

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
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	1..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	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Reference.type	extensible	ResourceType

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()

This structure is derived from Reference

Summary

Mandatory: 1 element
Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron