Physical Activity Implementation Guide
1.0.0-ballot - STU1 ballot-draft
Physical Activity Implementation Guide
1.0.0-ballot - STU1 ballot-draft
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 
| Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/reference-rest-or-logical | Version: 1.0.0-ballot | |||
| Active as of 2023-03-28 | Computable Name: ReferenceRestOrLogical | |||
A Reference data type where the referenced resource could be resolvable RESTfully or pointed to logically.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | ||||
| 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 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 | ||||
| Path | Conformance | ValueSet |
| Reference.identifier.use | required | IdentifierUse |
| 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() | |
| 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 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 | ||||
| Path | Conformance | ValueSet |
| Reference.type | extensible | ResourceType |
| Reference.identifier.use | required | IdentifierUse |
| Reference.identifier.type | extensible | Identifier Type Codes |
| 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
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 | ||||
| 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 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 | ||||
| Path | Conformance | ValueSet |
| Reference.identifier.use | required | IdentifierUse |
| 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() | |
| 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 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 | ||||
| Path | Conformance | ValueSet |
| Reference.type | extensible | ResourceType |
| Reference.identifier.use | required | IdentifierUse |
| Reference.identifier.type | extensible | Identifier Type Codes |
| 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
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International - Patient Care WG. Package hl7.fhir.us.physical-activity#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-03-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change