Personal Health Records
1.0.0-ballot2 - STU 1 ballot
Personal Health Records
1.0.0-ballot2 - STU 1 ballot
Personal Health Records, published by HL7 International / Patient Empowerment. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/personal-health-record-format-ig/ and changes regularly. See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 1 |
Definitions for the SocialMedia logical model
Guidance on how to interpret the contents of this table can be foundhere
| 0. SocialMedia | |
| Definition | A logical model representing a social media post from platforms such as Facebook, Instagram, Twitter/X, Tumblr, etc. Captures the post content, media attachments, and metadata. Relevant for patient-reported outcomes, behavioral health context, and longitudinal health narratives. |
| Short | Social Media Post |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. SocialMedia.subject | |
| Definition | The patient who authored or owns the post |
| Short | The patient who authored or owns the post |
| Control | 1..1 |
| Type | Reference(Patient) |
| 4. SocialMedia.platform | |
| Definition | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Short | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Control | 0..1 |
| Type | CodeableConcept |
| 6. SocialMedia.postDateTime | |
| Definition | Date and time the post was published |
| Short | Date and time the post was published |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. SocialMedia.title | |
| Definition | Title or headline of the post, if applicable |
| Short | Title or headline of the post, if applicable |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. SocialMedia.body | |
| Definition | Text body or description of the post |
| Short | Text body or description of the post |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. SocialMedia.url | |
| Definition | URL link to the original post |
| Short | URL link to the original post |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. SocialMedia.media | |
| Definition | Media attachments on the post |
| Short | Media attachments on the post |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. SocialMedia.media.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. SocialMedia.media.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on SocialMedia.media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SocialMedia.media.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 22. SocialMedia.media.type | |
| Definition | Type of media (e.g. image, video, audio, link) |
| Short | Type of media (e.g. image, video, audio, link) |
| Control | 0..1 |
| Type | CodeableConcept |
| 24. SocialMedia.media.url | |
| Definition | URL of the media resource |
| Short | URL of the media resource |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. SocialMedia.media.description | |
| Definition | Alt text or description of the media |
| Short | Alt text or description of the media |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. SocialMedia.tag | |
| Definition | Tags or hashtags associated with the post |
| Short | Tags or hashtags associated with the post |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. SocialMedia.visibility | |
| Definition | Visibility or privacy setting (e.g. public, friends-only, private) |
| Short | Visibility or privacy setting (e.g. public, friends-only, private) |
| Control | 0..1 |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SocialMedia | |
| Definition | A logical model representing a social media post from platforms such as Facebook, Instagram, Twitter/X, Tumblr, etc. Captures the post content, media attachments, and metadata. Relevant for patient-reported outcomes, behavioral health context, and longitudinal health narratives. |
| Short | Social Media Post |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. SocialMedia.subject | |
| Definition | The patient who authored or owns the post |
| Short | The patient who authored or owns the post |
| Control | 1..1 |
| Type | Reference(Patient) |
| 4. SocialMedia.platform | |
| Definition | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Short | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Control | 0..1 |
| Type | CodeableConcept |
| 6. SocialMedia.postDateTime | |
| Definition | Date and time the post was published |
| Short | Date and time the post was published |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. SocialMedia.title | |
| Definition | Title or headline of the post, if applicable |
| Short | Title or headline of the post, if applicable |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. SocialMedia.body | |
| Definition | Text body or description of the post |
| Short | Text body or description of the post |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. SocialMedia.url | |
| Definition | URL link to the original post |
| Short | URL link to the original post |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. SocialMedia.media | |
| Definition | Media attachments on the post |
| Short | Media attachments on the post |
| Control | 0..* |
| Type | BackboneElement |
| 16. SocialMedia.media.type | |
| Definition | Type of media (e.g. image, video, audio, link) |
| Short | Type of media (e.g. image, video, audio, link) |
| Control | 0..1 |
| Type | CodeableConcept |
| 18. SocialMedia.media.url | |
| Definition | URL of the media resource |
| Short | URL of the media resource |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. SocialMedia.media.description | |
| Definition | Alt text or description of the media |
| Short | Alt text or description of the media |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. SocialMedia.tag | |
| Definition | Tags or hashtags associated with the post |
| Short | Tags or hashtags associated with the post |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. SocialMedia.visibility | |
| Definition | Visibility or privacy setting (e.g. public, friends-only, private) |
| Short | Visibility or privacy setting (e.g. public, friends-only, private) |
| Control | 0..1 |
| Type | CodeableConcept |
Guidance on how to interpret the contents of this table can be foundhere
| 0. SocialMedia | |
| Definition | A logical model representing a social media post from platforms such as Facebook, Instagram, Twitter/X, Tumblr, etc. Captures the post content, media attachments, and metadata. Relevant for patient-reported outcomes, behavioral health context, and longitudinal health narratives. |
| Short | Social Media Post |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. SocialMedia.subject | |
| Definition | The patient who authored or owns the post |
| Short | The patient who authored or owns the post |
| Control | 1..1 |
| Type | Reference(Patient) |
| 4. SocialMedia.platform | |
| Definition | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Short | Social media platform (e.g. Facebook, Instagram, Twitter/X, Tumblr) |
| Control | 0..1 |
| Type | CodeableConcept |
| 6. SocialMedia.postDateTime | |
| Definition | Date and time the post was published |
| Short | Date and time the post was published |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. SocialMedia.title | |
| Definition | Title or headline of the post, if applicable |
| Short | Title or headline of the post, if applicable |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. SocialMedia.body | |
| Definition | Text body or description of the post |
| Short | Text body or description of the post |
| Control | 0..1 |
| Type | markdown |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. SocialMedia.url | |
| Definition | URL link to the original post |
| Short | URL link to the original post |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. SocialMedia.media | |
| Definition | Media attachments on the post |
| Short | Media attachments on the post |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. SocialMedia.media.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. SocialMedia.media.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on SocialMedia.media.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. SocialMedia.media.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. SocialMedia.media.type | |
| Definition | Type of media (e.g. image, video, audio, link) |
| Short | Type of media (e.g. image, video, audio, link) |
| Control | 0..1 |
| Type | CodeableConcept |
| 24. SocialMedia.media.url | |
| Definition | URL of the media resource |
| Short | URL of the media resource |
| Control | 0..1 |
| Type | url |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. SocialMedia.media.description | |
| Definition | Alt text or description of the media |
| Short | Alt text or description of the media |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. SocialMedia.tag | |
| Definition | Tags or hashtags associated with the post |
| Short | Tags or hashtags associated with the post |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 30. SocialMedia.visibility | |
| Definition | Visibility or privacy setting (e.g. public, friends-only, private) |
| Short | Visibility or privacy setting (e.g. public, friends-only, private) |
| Control | 0..1 |
| Type | CodeableConcept |
IG © 2022+ HL7 International / Patient Empowerment.
Package hl7.fhir.uv.phr#1.0.0-ballot2 based on FHIR 4.0.1.
Generated
2026-03-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change