Healthcare Financial Services IG Edition 1
0.3.0 - ci-build
Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Data Type Profile: DP_Annotation
| Official URL: http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Annotation | Version: 0.3.0 | |||
| Draft as of 2025-06-23 | Computable Name: DP_Annotation | |||
Text note with attribution.
Usage:
- Use this DataType Constraint: Nphies CommunicationRequest, Nphies Communication and Nphies VisionPrescription
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Annotation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Annotation |
0..* | Annotation | Text node with attribution | |
  Slices for author[x] |
S | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation Slice: Unordered, Open by type:$this |
   author[x]:authorString |
S | 0..1 | string | Individual responsible for the annotation Max Length:100 |
  time |
S | 0..1 | DP_dateTime | When the annotation was made |
 text |
1..1 | DP_markdown | The annotation - text content (as markdown) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Annotation |
0..* | Annotation | Text node with attribution ele-1: All FHIR elements must have a @value or children | |
| Slices for author[x] |
SΣ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
  authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString |
string | |||
| author[x]:authorString |
SΣ | 0..1 | string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children Max Length:100 |
| time |
SΣ | 0..1 | DP_dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | DP_markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
| 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()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Annotation |
0..* | Annotation | Text node with attribution | |
| id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for author[x] |
SΣ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString |
string | |||
| author[x]:authorString |
SΣ | 0..1 | string | Individual responsible for the annotation Max Length:100 |
| time |
SΣ | 0..1 | DP_dateTime | When the annotation was made |
| text |
Σ | 1..1 | DP_markdown | The annotation - text content (as markdown) |
| 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()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Annotation
Summary
Must-Support: 3 elements
Structures
This structure refers to these other structures:
- DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
- DP_markdown (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-markdown)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Annotation.author[x]
Differential View
This structure is derived from Annotation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Annotation |
0..* | Annotation | Text node with attribution | |
| Slices for author[x] |
S | 0..1 | Reference(Practitioner | Patient | RelatedPerson | Organization), string | Individual responsible for the annotation Slice: Unordered, Open by type:$this |
| author[x]:authorString |
S | 0..1 | string | Individual responsible for the annotation Max Length:100 |
| time |
S | 0..1 | DP_dateTime | When the annotation was made |
| text |
1..1 | DP_markdown | The annotation - text content (as markdown) | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Annotation |
0..* | Annotation | Text node with attribution ele-1: All FHIR elements must have a @value or children | |
| Slices for author[x] |
SΣ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children | |
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString |
string | |||
| author[x]:authorString |
SΣ | 0..1 | string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children Max Length:100 |
| time |
SΣ | 0..1 | DP_dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text |
Σ | 1..1 | DP_markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
| 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()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Annotation |
0..* | Annotation | Text node with attribution | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| Slices for author[x] |
SΣ | 0..1 | Individual responsible for the annotation Slice: Unordered, Open by type:$this | |
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString |
string | |||
| author[x]:authorString |
SΣ | 0..1 | string | Individual responsible for the annotation Max Length:100 |
| time |
SΣ | 0..1 | DP_dateTime | When the annotation was made |
| text |
Σ | 1..1 | DP_markdown | The annotation - text content (as markdown) |
| 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()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Annotation
Summary
Must-Support: 3 elements
Structures
This structure refers to these other structures:
- DP_dateTime (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-dateTime)
- DP_markdown (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-markdown)
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Annotation.author[x]
Other representations of profile: CSV, Excel, Schematron