StructureDefinition Extension-UKCore-FamilyMemberHistoryParticipant

Context of Use FamilyMemberHistory

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participantactive1.1.02023-12-12

An extension to indicate who or what participated in the activities related to the family member history and how they were involved.

This extension is a Genomics use case to replicate the R5 FamilyMemberHistory.participant functionality in R4, and is to be used to indicate who or what participated in the activities related to the family member history and how they were involved.


Tree View

id0..1string
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
valueReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Organization | CareTeam)
url1..1uriFixed Value

Detailed Descriptions

Extension
DefinitionAn extension to record who or what participated in the activities related to the family member history.
Cardinality0...*
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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension
DefinitionMay 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.
Cardinality1...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:function
DefinitionDistinguishes the type of involvement of the actor in the activities related to the family member history.
Cardinality0...1
TypeExtension
BindingParticipationRoleType (extensible)
Aliasextensions, 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.

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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:function.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension:function.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:function.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

function

Mappings
  • rim: N/A
Extension.extension:function.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeCodeableConcept
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:actor
DefinitionIndicates who or what participated in the activities related to the family member history.
Cardinality1...1
TypeExtension
Aliasextensions, 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.

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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:actor.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Extension.extension:actor.extension
DefinitionMay 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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
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()
Mappings
  • rim: n/a
  • rim: N/A
Extension.extension:actor.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

actor

Mappings
  • rim: N/A
Extension.extension:actor.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Organization | CareTeam)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Extension.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
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

http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant

Mappings
  • rim: N/A
Extension.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A

Table View

Extension..
Extension.extension1..
Extension.extension..1
Extension.extension.url..
Extension.extension.value[x]CodeableConcept1..
Extension.extension1..1
Extension.extension.url..
Extension.extension.value[x]Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | Organization | CareTeam)1..
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-FamilyMemberHistoryParticipant" />
    <url value="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" />
    <version value="1.1.0" />
    <name value="ExtensionUKCoreFamilyMemberHistoryParticipant" />
    <title value="Extension UKCore Family Member History Participant" />
    <status value="active" />
    <date value="2023-12-12" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="An extension to indicate who or what participated in the activities related to the family member history and how they were involved." />
    <purpose value="This extension is a Genomics use case to replicate the R5 FamilyMemberHistory.participant functionality in R4, and is to be used to indicate who or what participated in the activities related to the family member history and how they were involved." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="FamilyMemberHistory" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Who or what participated in the activities related to the family member history." />
            <definition value="An extension to record who or what participated in the activities related to the family member history." />
        </element>
        <element id="Extension.extension">
            <path value="Extension.extension" />
            <min value="1" />
        </element>
        <element id="Extension.extension:function">
            <path value="Extension.extension" />
            <sliceName value="function" />
            <short value="The type of involvement in the activities related to the family member history." />
            <definition value="Distinguishes the type of involvement of the actor in the activities related to the family member history." />
            <max value="1" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://hl7.org/fhir/ValueSet/participation-role-type" />
            </binding>
        </element>
        <element id="Extension.extension:function.url">
            <path value="Extension.extension.url" />
            <fixedUri value="function" />
        </element>
        <element id="Extension.extension:function.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="Extension.extension:actor">
            <path value="Extension.extension" />
            <sliceName value="actor" />
            <short value="Who or what participated in the activities related to the family member history." />
            <definition value="Indicates who or what participated in the activities related to the family member history." />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="Extension.extension:actor.url">
            <path value="Extension.extension.url" />
            <fixedUri value="actor" />
        </element>
        <element id="Extension.extension:actor.value[x]">
            <path value="Extension.extension.value[x]" />
            <min value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
                <targetProfile value="http://hl7.org/fhir/StructureDefinition/CareTeam" />
            </type>
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-FamilyMemberHistoryParticipant",
    "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant",
    "version": "1.1.0",
    "name": "ExtensionUKCoreFamilyMemberHistoryParticipant",
    "title": "Extension UKCore Family Member History Participant",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "An extension to indicate who or what participated in the activities related to the family member history and how they were involved.",
    "purpose": "This extension is a Genomics use case to replicate the R5 FamilyMemberHistory.participant functionality in R4, and is to be used to indicate who or what participated in the activities related to the family member history and how they were involved.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "FamilyMemberHistory"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Who or what participated in the activities related to the family member history.",
                "definition": "An extension to record who or what participated in the activities related to the family member history."
            },
            {
                "id": "Extension.extension",
                "path": "Extension.extension",
                "min": 1
            },
            {
                "id": "Extension.extension:function",
                "path": "Extension.extension",
                "sliceName": "function",
                "short": "The type of involvement in the activities related to the family member history.",
                "definition": "Distinguishes the type of involvement of the actor in the activities related to the family member history.",
                "max": "1",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type"
                }
            },
            {
                "id": "Extension.extension:function.url",
                "path": "Extension.extension.url",
                "fixedUri": "function"
            },
            {
                "id": "Extension.extension:function.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ]
            },
            {
                "id": "Extension.extension:actor",
                "path": "Extension.extension",
                "sliceName": "actor",
                "short": "Who or what participated in the activities related to the family member history.",
                "definition": "Indicates who or what participated in the activities related to the family member history.",
                "min": 1,
                "max": "1"
            },
            {
                "id": "Extension.extension:actor.url",
                "path": "Extension.extension.url",
                "fixedUri": "actor"
            },
            {
                "id": "Extension.extension:actor.value[x]",
                "path": "Extension.extension.value[x]",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://hl7.org/fhir/StructureDefinition/Patient",
                            "http://hl7.org/fhir/StructureDefinition/Practitioner",
                            "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
                            "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
                            "http://hl7.org/fhir/StructureDefinition/Device",
                            "http://hl7.org/fhir/StructureDefinition/Organization",
                            "http://hl7.org/fhir/StructureDefinition/CareTeam"
                        ]
                    }
                ]
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-FamilyMemberHistory.participant"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "max": "0"
            }
        ]
    }
}

Examples

Participant Reference - An example to illustrate the pre-adopted R5 element via an extension, which is used to indicate the performer of the family member history related activity.
Example UKCore-Extension-Participant

Extension Specific Guidance

Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles: