Profiles

StructureDefinition England-RelatedPerson-National-Proxy

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-National-Proxydraft0.0.1-current2024-10-25T07:31:19+00:00

RelatedPerson from National Proxy elaboration


Profile_Purpose

This documents requirement for NHS England National Proxy

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
contactPreferenceC0..1Extension(Complex)
copyCorrespondenceIndicatorC0..1Extension(boolean)
modifierExtension?! C0..*Extension
NHSNumberΣ0..1EnglandIdentifierNHSNumber
activeS Σ ?!1..1boolean
id0..1string
extensionC0..*Extension
referenceΣ C0..1string
typeΣ0..1uriBinding
identifierΣ0..1EnglandIdentifierNHSNumber
displayΣ0..1string
id0..1string
extensionC0..*Extension
codingΣ0..*CodingBinding
textΣ0..1string
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ1..1uriPattern
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameS Σ0..*HumanName
id0..1string
extensionC0..*Extension
id0..1string
otherContactSystemC0..1Extension(CodeableConcept)
value0..1System.String
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ0..1Period
genderΣ0..1codeBinding
birthDateS Σ0..1date
addressS Σ0..*Address
photo0..*Attachment
period0..1Period
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean

Detailed Descriptions

RelatedPerson
ShortA person that is related to a patient, but who is not a direct target of care
Definition

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Cardinality0..*
Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: role
RelatedPerson.id
ShortLogical id of this artifact
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality0..1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

RelatedPerson.meta
ShortMetadata about the resource
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality0..1
TypeMeta
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.implicitRules
ShortA set of rules under which this content was created
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.language
ShortLanguage of the resource content
Definition

The base language in which the resource is written.

Cardinality0..1
Typecode
Binding

A human language.

CommonLanguages (preferred)

Binding extensions
maxValueSetAllLanguages
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.text
ShortText summary of the resource, for human interpretation
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
RelatedPerson.contained
ShortContained, inline Resources
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Cardinality0..*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
RelatedPerson.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

Slicing

Unordered, Open, by url(Value)

Constraints
  • 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
RelatedPerson.extension:contactPreference
ShortThe preferred method of contact, contact times and written communication format given by a Patient or Related Person.
Definition

The preferred method of contact, contact times and written communication format given by a Patient or Related Person.

Cardinality0..1
TypeExtension(Complex)
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • 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
RelatedPerson.extension:copyCorrespondenceIndicator
ShortIndicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence.
Definition

Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.

Cardinality0..1
TypeExtension(boolean)
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • 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
RelatedPerson.modifierExtension
ShortExtensions that cannot be ignored
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).

Cardinality0..*
TypeExtension
ModifierTrue
Aliasextensions, user content
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.

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.

Constraints
  • 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
RelatedPerson.identifier
ShortA human identifier for this person
Definition

Identifier for a person within a particular scope.

Cardinality0..*
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Slicing

Unordered, Closed, by system(Pattern)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: NK1-33
  • rim: .id
RelatedPerson.identifier:NHSNumber
ShortAn identifier intended for computation
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Cardinality0..1
TypeEnglandIdentifierNHSNumber
SummaryTrue
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: NK1-33
  • rim: .id
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
RelatedPerson.active
ShortWhether this related person's record is in active use.
Definition

Whether this related person record is in active use.

Cardinality1..1
Typeboolean
Must SupportTrue
ModifierTrue
SummaryTrue
Requirements

Need to be able to mark a related person record as not to be used, such as if it was created in error.

Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Meaning when missing

This resource is generally assumed to be active if no value is provided for the active element

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
RelatedPerson.patient
ShortThe patient this person is related to.
Definition

The patient this person is related to.

Cardinality1..1
TypeReference(Patient)
Must SupportTrue
SummaryTrue
Requirements

We need to know which patient this RelatedPerson is related to.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-3
  • rim: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
RelatedPerson.patient.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.patient.extension
ShortAdditional content defined by implementations
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.

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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
RelatedPerson.patient.reference
ShortLiteral reference, Relative, internal or absolute URL
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Cardinality0..1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

ConditionsThe cardinality or value of this element may be affected by these constraints: ref-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
RelatedPerson.patient.type
ShortType the reference refers to (e.g. "Patient")
Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Cardinality0..1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
RelatedPerson.patient.identifier
ShortAn identifier intended for computation
Definition

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

Cardinality0..1
TypeEnglandIdentifierNHSNumber
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
RelatedPerson.patient.display
ShortText alternative for the resource
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality0..1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
RelatedPerson.relationship
ShortThe nature of the relationship.
Definition

The nature of the relationship between a patient and the related person.

Cardinality1..3
TypeCodeableConcept
Binding

The nature of the relationship between a patient and the related person.

UKCorePersonRelationshipType (extensible)

Must SupportTrue
SummaryTrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Slicing

Unordered, Open At End, by coding.system(Pattern)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
RelatedPerson.relationship.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.relationship.extension
ShortAdditional content defined by implementations
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.

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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
RelatedPerson.relationship.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
Binding

PatientRelationshipType (preferred)

SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
RelatedPerson.relationship.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
RelatedPerson.relationship:Type
ShortThe nature of the relationship.
Definition

The nature of the relationship between a patient and the related person.

Cardinality0..1
TypeCodeableConcept
Binding

The nature of the relationship between a patient and the related person.

UKCorePersonRelationshipType (extensible)

Must SupportTrue
SummaryTrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
RelatedPerson.relationship:Type.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.relationship:Type.extension
ShortAdditional content defined by implementations
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.

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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
RelatedPerson.relationship:Type.coding
ShortCode defined by a terminology system
Definition

A reference to a code defined by a terminology system.

Cardinality0..*
TypeCoding
Binding

PatientRelationshipType (preferred)

SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
RelatedPerson.relationship:Type.coding.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.relationship:Type.coding.extension
ShortAdditional content defined by implementations
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.

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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
RelatedPerson.relationship:Type.coding.system
ShortIdentity of the terminology system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality1..1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern
http://terminology.hl7.org/CodeSystem/v3-RoleCode
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
RelatedPerson.relationship:Type.coding.version
ShortVersion of the system - if relevant
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Cardinality0..1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
RelatedPerson.relationship:Type.coding.code
ShortSymbol in syntax defined by the system
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Cardinality0..1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
RelatedPerson.relationship:Type.coding.display
ShortRepresentation defined by the system
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
RelatedPerson.relationship:Type.coding.userSelected
ShortIf this coding was chosen directly by the user
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality0..1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
RelatedPerson.relationship:Type.text
ShortPlain text representation of the concept
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Cardinality0..1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
RelatedPerson.name
ShortA name associated with the person.
Definition

A name associated with the person.

Cardinality0..*
TypeHumanName
Must SupportTrue
SummaryTrue
Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-2
  • rim: name
RelatedPerson.telecom
ShortA contact detail for the person.
Definition

A contact detail for the person, e.g. a telephone number or an email address.

Cardinality0..*
TypeContactPoint
Must SupportTrue
SummaryTrue
Requirements

People have (primary) ways to contact them in some way such as phone, email.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-5 / NK1-6 / NK1-40
  • rim: telecom
RelatedPerson.telecom.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.telecom.extension
ShortAdditional content defined by implementations
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.

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.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints
  • 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
RelatedPerson.telecom.system
Shortphone | fax | email | pager | url | sms | other
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Cardinality0..1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)

SummaryTrue
ConditionsThe cardinality or value of this element may be affected by these constraints: cpt-2
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
RelatedPerson.telecom.system.id
Shortxml:id (or equivalent in JSON)
Definition

unique id for the element within a resource (for internal references)

Cardinality0..1
Typestring
RelatedPerson.telecom.system.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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.

Slicing

Unordered, Open, by url(Value)

Constraints
  • 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()
RelatedPerson.telecom.system.extension:otherContactSystem
ShortInformation about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
Definition

Other contact system value which extends the system element in the ContactPoint datatype.

Cardinality0..1
TypeExtension(CodeableConcept)
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.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • 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
RelatedPerson.telecom.system.value
ShortPrimitive value for code
Definition

Primitive value for code

Cardinality0..1
TypeSystem.String
RelatedPerson.telecom.value
ShortThe actual contact point details
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Cardinality0..1
Typestring
SummaryTrue
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
RelatedPerson.telecom.use
Shorthome | work | temp | old | mobile - purpose of this contact point
Definition

Identifies the purpose for the contact point.

Cardinality0..1
Typecode
Binding

Use of contact point.

ContactPointUse (required)

ModifierTrue
SummaryTrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
RelatedPerson.telecom.rank
ShortSpecify preferred order of use (1 = highest)
Definition

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Cardinality0..1
TypepositiveInt
SummaryTrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: n/a
  • rim: n/a
RelatedPerson.telecom.period
ShortTime period when the contact point was/is in use
Definition

Time period when the contact point was/is in use.

Cardinality0..1
TypePeriod
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
RelatedPerson.gender
Shortmale | female | other | unknown
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Cardinality0..1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)

SummaryTrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-15
  • rim: administrativeGender
RelatedPerson.birthDate
ShortThe date on which the related person was born
Definition

The date on which the related person was born.

Cardinality0..1
Typedate
Must SupportTrue
SummaryTrue
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player.birthTime
RelatedPerson.address
ShortAddress where the related person can be contacted or visited.
Definition

Address where the related person can be contacted or visited.

Cardinality0..*
TypeAddress
Must SupportTrue
SummaryTrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-4
  • rim: addr
RelatedPerson.photo
ShortImage of the person
Definition

Image of the person.

Cardinality0..*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 - needs a profile
  • rim: player[classCode='PSN' and determinerCode='INSTANCE']/desc
RelatedPerson.period
ShortPeriod of time that this relationship is considered valid
Definition

The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.

Cardinality0..1
TypePeriod
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
RelatedPerson.communication
ShortA language which may be used to communicate with about the patient's health
Definition

A language which may be used to communicate with about the patient's health.

Cardinality0..*
TypeBackboneElement
Requirements

If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: LanguageCommunication
RelatedPerson.communication.id
ShortUnique id for inter-element referencing
Definition

Unique 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
RelatedPerson.communication.extension
ShortAdditional content defined by implementations
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.

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.

Constraints
  • 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
RelatedPerson.communication.modifierExtension
ShortExtensions that cannot be ignored even if unrecognized
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).

Cardinality0..*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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.

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.

Constraints
  • 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
RelatedPerson.communication.language
ShortThe language which can be used to communicate with the patient about his or her health
Definition

The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.

Cardinality1..1
TypeCodeableConcept
Binding

A language which may be used to communicate with the related person about the patient's health.

AllLanguages (required)

Binding extensions
maxValueSetAllLanguages
Requirements

Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
RelatedPerson.communication.preferred
ShortLanguage preference indicator
Definition

Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Cardinality0..1
Typeboolean
Requirements

People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.

Comments

This language is specifically identified for communicating healthcare information.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: preferenceInd

Table View

RelatedPerson..
RelatedPerson.identifier..
RelatedPerson.identifier:NHSNumberEnglandIdentifierNHSNumber..1
RelatedPerson.active1..
RelatedPerson.patient..
RelatedPerson.patient.identifierEnglandIdentifierNHSNumber..
RelatedPerson.relationship1..3
RelatedPerson.relationship.coding..
RelatedPerson.relationship:Type..1
RelatedPerson.relationship.coding..
RelatedPerson.relationship:Type.coding.system1..
RelatedPerson.birthDate..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="England-RelatedPerson-National-Proxy" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-National-Proxy" />
<version value="0.0.1-current" />
<name value="EnglandRelatedPersonNationalProxy" />
<title value="England Related Person National Proxy" />
<status value="draft" />
<date value="2024-10-25T07:31:19+00:00" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="RelatedPerson from National Proxy elaboration" />
<purpose value="This documents requirement for NHS England National Proxy" />
<copyright value="Copyright © 2024+ NHS England 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 value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="RelatedPerson" />
<baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
<derivation value="constraint" />
<element id="RelatedPerson.identifier">
<path value="RelatedPerson.identifier" />
<type value="pattern" />
<path value="system" />
</discriminator>
<rules value="closed" />
</slicing>
<mustSupport value="true" />
</element>
<element id="RelatedPerson.identifier:NHSNumber">
<path value="RelatedPerson.identifier" />
<sliceName value="NHSNumber" />
<max value="1" />
<code value="Identifier" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" />
</type>
</element>
<element id="RelatedPerson.active">
<path value="RelatedPerson.active" />
<min value="1" />
</element>
<element id="RelatedPerson.patient.identifier">
<path value="RelatedPerson.patient.identifier" />
<code value="Identifier" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" />
</type>
</element>
<element id="RelatedPerson.relationship">
<path value="RelatedPerson.relationship" />
<type value="pattern" />
<path value="coding.system" />
</discriminator>
<rules value="openAtEnd" />
</slicing>
<min value="1" />
<max value="3" />
</element>
<element id="RelatedPerson.relationship.coding">
<path value="RelatedPerson.relationship.coding" />
<strength value="preferred" />
<valueSet value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" />
</binding>
</element>
<element id="RelatedPerson.relationship:Type">
<path value="RelatedPerson.relationship" />
<sliceName value="Type" />
<max value="1" />
</element>
<element id="RelatedPerson.relationship:Type.coding.system">
<path value="RelatedPerson.relationship.coding.system" />
<min value="1" />
<patternUri value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
</element>
<element id="RelatedPerson.birthDate">
<path value="RelatedPerson.birthDate" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "England-RelatedPerson-National-Proxy",
"url": "https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-National-Proxy",
"version": "0.0.1-current",
"name": "EnglandRelatedPersonNationalProxy",
"title": "England Related Person National Proxy",
"status": "draft",
"date": "2024-10-25T07:31:19+00:00",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "RelatedPerson from National Proxy elaboration",
"purpose": "This documents requirement for NHS England National Proxy",
"copyright": "Copyright © 2024+ NHS England 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",
"kind": "resource",
"abstract": false,
"type": "RelatedPerson",
"baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
"derivation": "constraint",
"element": [
{
"id": "RelatedPerson.identifier",
"path": "RelatedPerson.identifier",
"slicing": {
{
"type": "pattern",
"path": "system"
}
],
"rules": "closed"
},
"mustSupport": true
},
{
"id": "RelatedPerson.identifier:NHSNumber",
"path": "RelatedPerson.identifier",
"sliceName": "NHSNumber",
"max": "1",
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number"
]
}
]
},
{
"id": "RelatedPerson.active",
"path": "RelatedPerson.active",
"min": 1
},
{
"id": "RelatedPerson.patient.identifier",
"path": "RelatedPerson.patient.identifier",
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number"
]
}
]
},
{
"id": "RelatedPerson.relationship",
"path": "RelatedPerson.relationship",
"slicing": {
{
"type": "pattern",
"path": "coding.system"
}
],
"rules": "openAtEnd"
},
"min": 1,
"max": "3"
},
{
"id": "RelatedPerson.relationship.coding",
"path": "RelatedPerson.relationship.coding",
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype"
}
},
{
"id": "RelatedPerson.relationship:Type",
"path": "RelatedPerson.relationship",
"sliceName": "Type",
"max": "1"
},
{
"id": "RelatedPerson.relationship:Type.coding.system",
"path": "RelatedPerson.relationship.coding.system",
"min": 1,
"patternUri": "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
},
{
"id": "RelatedPerson.birthDate",
"path": "RelatedPerson.birthDate",
"mustSupport": true
}
]
}
}

Feedback

Click here to:

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

StructureDefinition England-Task-National-Proxy

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.nhs.uk/England/StructureDefinition/England-Task-National-Proxydraft0.0.1-current2024-10-25T07:31:19+00:00

Task


Profile_Purpose

This documents requirement for NHS England National Proxy

identifierS1..
businessStatusS
code1..Binding
focusEnglandCodeableReference(Resource)
identifierEnglandIdentifierNHSNumber
identifier1..EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierOrganisationCode
identifier1..EnglandIdentifierGeneralMedicalPractitionerCode, EnglandIdentifierGeneralMedicalCouncilReferenceNumber, EnglandIdentifierOrganisationCode
noteS

Detailed Descriptions

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="England-Task-National-Proxy" />
<url value="https://fhir.nhs.uk/England/StructureDefinition/England-Task-National-Proxy" />
<version value="0.0.1-current" />
<name value="EnglandTaskNationalProxy" />
<title value="England Task National Proxy" />
<status value="draft" />
<date value="2024-10-25T07:31:19+00:00" />
<publisher value="NHS England" />
<name value="NHS England" />
<system value="email" />
<value value="interoperabilityteam@nhs.net" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="Task" />
<purpose value="This documents requirement for NHS England National Proxy" />
<copyright value="Copyright © 2024+ NHS England 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 value="4.0.1" />
<kind value="resource" />
<abstract value="false" />
<type value="Task" />
<baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task" />
<derivation value="constraint" />
<element id="Task.identifier">
<path value="Task.identifier" />
<min value="1" />
<mustSupport value="true" />
</element>
<element id="Task.businessStatus">
<path value="Task.businessStatus" />
<mustSupport value="true" />
</element>
<element id="Task.code">
<path value="Task.code" />
<min value="1" />
<strength value="extensible" />
<valueSet value="https://fhir.nhs.uk/England/ValueSet/England-TaskCode" />
</binding>
</element>
<element id="Task.focus">
<path value="Task.focus" />
<code value="Reference" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-CodeableReference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" />
</type>
</element>
<element id="Task.for">
<path value="Task.for" />
<min value="1" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
</type>
</element>
<element id="Task.for.identifier">
<path value="Task.for.identifier" />
<code value="Identifier" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" />
</type>
</element>
<element id="Task.requester">
<path value="Task.requester" />
<min value="1" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
</type>
</element>
<element id="Task.requester.identifier">
<path value="Task.requester.identifier" />
<short value="SDS-User-Id is not part of NHS Data Dictionary and so should not be present here as an identifier." />
<min value="1" />
<code value="Identifier" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code" />
</type>
</element>
<element id="Task.owner">
<path value="Task.owner" />
<min value="1" />
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
<targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService" />
</type>
</element>
<element id="Task.owner.identifier">
<path value="Task.owner.identifier" />
<short value="SDS-User-Id is not part of NHS Data Dictionary and so should not be present here as an identifer." />
<min value="1" />
<code value="Identifier" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number" />
<profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code" />
</type>
</element>
<element id="Task.note">
<path value="Task.note" />
<mustSupport value="true" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "England-Task-National-Proxy",
"url": "https://fhir.nhs.uk/England/StructureDefinition/England-Task-National-Proxy",
"version": "0.0.1-current",
"name": "EnglandTaskNationalProxy",
"title": "England Task National Proxy",
"status": "draft",
"date": "2024-10-25T07:31:19+00:00",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "Task",
"purpose": "This documents requirement for NHS England National Proxy",
"copyright": "Copyright © 2024+ NHS England 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",
"kind": "resource",
"abstract": false,
"type": "Task",
"baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task",
"derivation": "constraint",
"element": [
{
"id": "Task.identifier",
"path": "Task.identifier",
"min": 1,
"mustSupport": true
},
{
"id": "Task.businessStatus",
"path": "Task.businessStatus",
"mustSupport": true
},
{
"id": "Task.code",
"path": "Task.code",
"min": 1,
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.nhs.uk/England/ValueSet/England-TaskCode"
}
},
{
"id": "Task.focus",
"path": "Task.focus",
"type": [
{
"code": "Reference",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-CodeableReference"
],
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
]
},
{
"id": "Task.for",
"path": "Task.for",
"min": 1,
"type": [
{
"code": "Reference",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
]
}
]
},
{
"id": "Task.for.identifier",
"path": "Task.for.identifier",
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number"
]
}
]
},
{
"id": "Task.requester",
"path": "Task.requester",
"min": 1,
"type": [
{
"code": "Reference",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner"
]
}
]
},
{
"id": "Task.requester.identifier",
"path": "Task.requester.identifier",
"short": "SDS-User-Id is not part of NHS Data Dictionary and so should not be present here as an identifier.",
"min": 1,
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code",
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number",
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code"
]
}
]
},
{
"id": "Task.owner",
"path": "Task.owner",
"min": 1,
"type": [
{
"code": "Reference",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
"https://fhir.hl7.org.uk/StructureDefinition/UKCore-HealthcareService"
]
}
]
},
{
"id": "Task.owner.identifier",
"path": "Task.owner.identifier",
"short": "SDS-User-Id is not part of NHS Data Dictionary and so should not be present here as an identifer.",
"min": 1,
"type": [
{
"code": "Identifier",
"profile": [
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Practitioner-Code",
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-General-Medical-Council-Reference-Number",
"https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-Organisation-Code"
]
}
]
},
{
"id": "Task.note",
"path": "Task.note",
"mustSupport": true
}
]
}
}

Feedback

Click here to:

, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,