Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Draft as of 2024-03-08 |
Definitions for the Extension-Interweave-SocialCareSupportRole extension.
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Social Care Support Role: The role which a person plays in a service user's support Optional Extension Element - found in all resources. |
| Control | 0..1* |
| 2. Extension.extension | |
| Control | 10..* |
| 3. Extension.extension:supportRoleType | |
| SliceName | supportRoleType |
| Definition | Social Care Support Role |
| Control | 1..1 |
| Must Support | true |
| 4. Extension.extension:supportRoleType.extension | |
| Control | 0..0 |
| 5. Extension.extension:supportRoleType.url | |
| Control | 0..? |
| Fixed Value | supportRoleType |
| 6. Extension.extension:supportRoleType.value[x] | |
| Control | 0..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:supportRoleType.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Control | 0..1 |
| Binding | The codes SHALL be taken from InterweaveSocialCareSupportRole |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 8. Extension.extension:supportRolePeriod | |
| SliceName | supportRolePeriod |
| Definition | Support role period. |
| Control | 0..1 |
| 9. Extension.extension:supportRolePeriod.extension | |
| Control | 0..0 |
| 10. Extension.extension:supportRolePeriod.url | |
| Control | 0..? |
| Fixed Value | supportRolePeriod |
| 11. Extension.extension:supportRolePeriod.value[x] | |
| Control | 0..? |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 12. Extension.extension:supportRolePeriod.value[x]:valuePeriod | |
| SliceName | valuePeriod |
| Control | 0..1 |
| Type | Period |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 13. Extension.url | |
| Fixed Value | https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole |
| 14. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Social Care Support Role: The role which a person plays in a service user's support Optional Extension Element - found in all resources. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 10..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 3. Extension.extension:supportRoleType | |
| SliceName | supportRoleType |
| Definition | Social Care Support Role May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 10..1* |
| Type | Extension |
| Must Support | true |
| Alternate Names | extensions, user content |
| 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. |
| 4. Extension.extension:supportRoleType.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..0* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Extension.extension:supportRoleType.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | supportRoleType |
| 6. Extension.extension:supportRoleType.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | Choice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:supportRoleType.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from InterweaveSocialCareSupportRoleFor codes, see (unbound) |
| Type | Choice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 8. Extension.extension:supportRolePeriod | |
| SliceName | supportRolePeriod |
| Definition | Support role period. May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..1* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| 9. Extension.extension:supportRolePeriod.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..0* |
| Type | Extension |
| Alternate Names | extensions, user content |
| 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. |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 10. Extension.extension:supportRolePeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | supportRolePeriod |
| 11. Extension.extension:supportRolePeriod.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | Choice of: Period, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 12. Extension.extension:supportRolePeriod.value[x]:valuePeriod | |
| SliceName | valuePeriod |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | Choice of: Period, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 13. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole |
| 14. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..01 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | Social Care Support Role: The role which a person plays in a service user's support |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| 2. Extension.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 3. Extension.extension | |
| Definition | An Extension |
| Control | 1..* |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.extension:supportRoleType | |
| SliceName | supportRoleType |
| Definition | Social Care Support Role |
| Control | 1..1 |
| Type | Extension |
| Must Support | true |
| 5. Extension.extension:supportRoleType.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 6. Extension.extension:supportRoleType.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:supportRoleType.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | supportRoleType |
| 8. Extension.extension:supportRoleType.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 9. Extension.extension:supportRoleType.value[x]:valueCodeableConcept | |
| SliceName | valueCodeableConcept |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from InterweaveSocialCareSupportRole |
| Type | CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 10. Extension.extension:supportRolePeriod | |
| SliceName | supportRolePeriod |
| Definition | Support role period. |
| Control | 0..1 |
| Type | Extension |
| 11. Extension.extension:supportRolePeriod.id | |
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 12. Extension.extension:supportRolePeriod.extension | |
| Definition | An Extension |
| Control | 0..0 |
| Type | Extension |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 13. Extension.extension:supportRolePeriod.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | supportRolePeriod |
| 14. Extension.extension:supportRolePeriod.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | Period |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Slicing | This element introduces a set of slices on Extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
| 15. Extension.extension:supportRolePeriod.value[x]:valuePeriod | |
| SliceName | valuePeriod |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..1 |
| Type | Period |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 16. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | https://fhir.yhcr.nhs.uk/StructureDefinition/Extension-Interweave-SocialCareSupportRole |
| 17. Extension.value[x] | |
| Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| Control | 0..0 |
| Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |