Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_RelatedPerson_R5

Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-RelatedPerson Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R2_RelatedPerson_R5

This cross-version profile allows DSTU2 RelatedPerson content to be represented via FHIR R5 RelatedPerson resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) The patient this person is related to
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.patient.reference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.modifierExtension, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relationship
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:relationship 0..1 CodeableConcept DSTU2: The nature of the relationship additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.relationship
Binding: PatientRelationshipType (required): The nature of the relationship between a patient and the related person
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.name
... telecom
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.address
... photo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:photo 0..* Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.photo
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient) The patient this person is related to
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... relationship Σ 0..* CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relationship 0..1 CodeableConcept DSTU2: The nature of the relationship additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.relationship
Binding: PatientRelationshipType (required): The nature of the relationship between a patient and the related person
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... name Σ 0..* HumanName A name associated with the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.name
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem . (required): Telecommunications form for contact point.
.... value ΣC 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* Address Address where the related person can be contacted or visited
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:photo 0..* Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.photo
Constraints: ext-1
.... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
.... data C 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages
... period 0..1 Period Period of time that this relationship is considered valid
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... communication 0..* BackboneElement A language which may be used to communicate with the related person about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the related person about the patient's health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
RelatedPerson.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
RelatedPerson.language Base required All Languages 📍5.0.0 FHIR Std.
RelatedPerson.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
RelatedPerson.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
RelatedPerson.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
RelatedPerson.patient.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
RelatedPerson.relationship Base preferred Patient Relationship Type 📍5.0.0 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍5.0.0 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem . 📍5.0.0 tx.fhir.org
RelatedPerson.telecom.​use Base required ContactPointUse 📍5.0.0 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍5.0.0 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍5.0.0 FHIR Std.
RelatedPerson.photo.​contentType Base required Mime Types 📍5.0.0 FHIR Std.
RelatedPerson.photo.​language Base required All Languages 📍5.0.0 FHIR Std.
RelatedPerson.communication.​language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.meta, RelatedPerson.meta.extension, RelatedPerson.meta.extension:meta, RelatedPerson.meta.versionId, RelatedPerson.meta.lastUpdated, RelatedPerson.meta.source, RelatedPerson.meta.profile, RelatedPerson.meta.security, RelatedPerson.meta.tag, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.text.extension, RelatedPerson.text.extension:text, RelatedPerson.text.status, RelatedPerson.text.div, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.identifier.extension, RelatedPerson.identifier.extension:identifier, RelatedPerson.identifier.use, RelatedPerson.identifier.type, RelatedPerson.identifier.system, RelatedPerson.identifier.value, RelatedPerson.identifier.period, RelatedPerson.identifier.assigner, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.patient.reference, RelatedPerson.patient.type, RelatedPerson.patient.identifier, RelatedPerson.patient.display, RelatedPerson.relationship, RelatedPerson.relationship.extension, RelatedPerson.relationship.extension:relationship, RelatedPerson.relationship.coding, RelatedPerson.relationship.text, RelatedPerson.name, RelatedPerson.name.extension, RelatedPerson.name.extension:name, RelatedPerson.name.use, RelatedPerson.name.text, RelatedPerson.name.family, RelatedPerson.name.given, RelatedPerson.name.prefix, RelatedPerson.name.suffix, RelatedPerson.name.period, RelatedPerson.telecom, RelatedPerson.telecom.extension, RelatedPerson.telecom.extension:telecom, RelatedPerson.telecom.system, RelatedPerson.telecom.value, RelatedPerson.telecom.use, RelatedPerson.telecom.rank, RelatedPerson.telecom.period, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.address.extension, RelatedPerson.address.extension:address, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.text, RelatedPerson.address.line, RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.state, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.period, RelatedPerson.photo, RelatedPerson.photo.extension, RelatedPerson.photo.extension:photo, RelatedPerson.photo.contentType, RelatedPerson.photo.language, RelatedPerson.photo.data, RelatedPerson.photo.url, RelatedPerson.photo.size, RelatedPerson.photo.hash, RelatedPerson.photo.title, RelatedPerson.photo.creation, RelatedPerson.photo.height, RelatedPerson.photo.width, RelatedPerson.photo.frames, RelatedPerson.photo.duration, RelatedPerson.photo.pages, RelatedPerson.period, RelatedPerson.period.extension, RelatedPerson.period.extension:period, RelatedPerson.period.start, RelatedPerson.period.end, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.meta.extension, RelatedPerson.meta.extension:meta, RelatedPerson.text.extension, RelatedPerson.text.extension:text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier.extension, RelatedPerson.identifier.extension:identifier, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.relationship.extension, RelatedPerson.relationship.extension:relationship, RelatedPerson.name.extension, RelatedPerson.name.extension:name, RelatedPerson.telecom.extension, RelatedPerson.telecom.extension:telecom, RelatedPerson.address.extension, RelatedPerson.address.extension:address, RelatedPerson.photo.extension, RelatedPerson.photo.extension:photo, RelatedPerson.period.extension, RelatedPerson.period.extension:period, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error RelatedPerson.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error RelatedPerson.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... patient Σ 1..1 Reference(Patient) The patient this person is related to
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.implicitRules, RelatedPerson.modifierExtension, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.patient.reference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.modifierExtension, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.text
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... relationship
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:relationship 0..1 CodeableConcept DSTU2: The nature of the relationship additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.relationship
Binding: PatientRelationshipType (required): The nature of the relationship between a patient and the related person
... name
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.name
... telecom
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.telecom
... address
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.address
... photo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:photo 0..* Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.photo
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.period

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* RelatedPerson(5.0.0) A person that is related to a patient, but who is not a direct target of care
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier A human identifier for this person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!Σ 0..1 boolean Whether this related person's record is in active use
... patient Σ 1..1 Reference(Patient) The patient this person is related to
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:patient 0..1 Reference(Resource) DSTU2: patient additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... relationship Σ 0..* CodeableConcept The relationship of the related person to the patient
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:relationship 0..1 CodeableConcept DSTU2: The nature of the relationship additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.relationship
Binding: PatientRelationshipType (required): The nature of the relationship between a patient and the related person
Constraints: ext-1
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... name Σ 0..* HumanName A name associated with the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 HumanName DSTU2: name additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.name
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
.... text Σ 0..1 string Text representation of the full name
.... family Σ 0..1 string Family name (often called 'Surname')
.... given Σ 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... telecom Σ 0..* ContactPoint A contact detail for the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: telecom additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.telecom
Constraints: ext-1
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem . (required): Telecommunications form for contact point.
.... value ΣC 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address Σ 0..* Address Address where the related person can be contacted or visited
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:address 0..* Address DSTU2: address additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.address
Constraints: ext-1
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address (home / work / etc.).
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. may be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... photo 0..* Attachment Image of the person
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:photo 0..* Attachment DSTU2: photo additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.photo
Constraints: ext-1
.... contentType ΣC 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
.... language Σ 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
.... data C 0..1 base64Binary Data inline, base64ed
.... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... size Σ 0..1 integer64 Number of bytes of content (if url provided)
.... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
.... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
.... creation Σ 0..1 dateTime Date attachment was first created
.... height 0..1 positiveInt Height of the image in pixels (photo/video)
.... width 0..1 positiveInt Width of the image in pixels (photo/video)
.... frames 0..1 positiveInt Number of frames if > 1 (photo)
.... duration 0..1 decimal Length in seconds (audio / video)
.... pages 0..1 positiveInt Number of printed pages
... period 0..1 Period Period of time that this relationship is considered valid
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-RelatedPerson.period
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... communication 0..* BackboneElement A language which may be used to communicate with the related person about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... language 1..1 CodeableConcept The language which can be used to communicate with the related person about the patient's health
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
.... preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedPerson.meta.security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
RelatedPerson.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
RelatedPerson.language Base required All Languages 📍5.0.0 FHIR Std.
RelatedPerson.text.status Base required NarrativeStatus 📍5.0.0 FHIR Std.
RelatedPerson.identifier.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
RelatedPerson.identifier.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
RelatedPerson.patient.​type Base extensible Resource Types . 📍5.0.0 tx.fhir.org
RelatedPerson.relationship Base preferred Patient Relationship Type 📍5.0.0 FHIR Std.
RelatedPerson.name.use Base required NameUse 📍5.0.0 FHIR Std.
RelatedPerson.telecom.​system Base required ContactPointSystem . 📍5.0.0 tx.fhir.org
RelatedPerson.telecom.​use Base required ContactPointUse 📍5.0.0 FHIR Std.
RelatedPerson.gender Base required AdministrativeGender 📍5.0.0 FHIR Std.
RelatedPerson.address.​use Base required AddressUse 📍5.0.0 FHIR Std.
RelatedPerson.address.​type Base required AddressType 📍5.0.0 FHIR Std.
RelatedPerson.photo.​contentType Base required Mime Types 📍5.0.0 FHIR Std.
RelatedPerson.photo.​language Base required All Languages 📍5.0.0 FHIR Std.
RelatedPerson.communication.​language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson 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 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error RelatedPerson.meta, RelatedPerson.meta.extension, RelatedPerson.meta.extension:meta, RelatedPerson.meta.versionId, RelatedPerson.meta.lastUpdated, RelatedPerson.meta.source, RelatedPerson.meta.profile, RelatedPerson.meta.security, RelatedPerson.meta.tag, RelatedPerson.implicitRules, RelatedPerson.language, RelatedPerson.text, RelatedPerson.text.extension, RelatedPerson.text.extension:text, RelatedPerson.text.status, RelatedPerson.text.div, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier, RelatedPerson.identifier.extension, RelatedPerson.identifier.extension:identifier, RelatedPerson.identifier.use, RelatedPerson.identifier.type, RelatedPerson.identifier.system, RelatedPerson.identifier.value, RelatedPerson.identifier.period, RelatedPerson.identifier.assigner, RelatedPerson.active, RelatedPerson.patient, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.patient.reference, RelatedPerson.patient.type, RelatedPerson.patient.identifier, RelatedPerson.patient.display, RelatedPerson.relationship, RelatedPerson.relationship.extension, RelatedPerson.relationship.extension:relationship, RelatedPerson.relationship.coding, RelatedPerson.relationship.text, RelatedPerson.name, RelatedPerson.name.extension, RelatedPerson.name.extension:name, RelatedPerson.name.use, RelatedPerson.name.text, RelatedPerson.name.family, RelatedPerson.name.given, RelatedPerson.name.prefix, RelatedPerson.name.suffix, RelatedPerson.name.period, RelatedPerson.telecom, RelatedPerson.telecom.extension, RelatedPerson.telecom.extension:telecom, RelatedPerson.telecom.system, RelatedPerson.telecom.value, RelatedPerson.telecom.use, RelatedPerson.telecom.rank, RelatedPerson.telecom.period, RelatedPerson.gender, RelatedPerson.birthDate, RelatedPerson.address, RelatedPerson.address.extension, RelatedPerson.address.extension:address, RelatedPerson.address.use, RelatedPerson.address.type, RelatedPerson.address.text, RelatedPerson.address.line, RelatedPerson.address.city, RelatedPerson.address.district, RelatedPerson.address.state, RelatedPerson.address.postalCode, RelatedPerson.address.country, RelatedPerson.address.period, RelatedPerson.photo, RelatedPerson.photo.extension, RelatedPerson.photo.extension:photo, RelatedPerson.photo.contentType, RelatedPerson.photo.language, RelatedPerson.photo.data, RelatedPerson.photo.url, RelatedPerson.photo.size, RelatedPerson.photo.hash, RelatedPerson.photo.title, RelatedPerson.photo.creation, RelatedPerson.photo.height, RelatedPerson.photo.width, RelatedPerson.photo.frames, RelatedPerson.photo.duration, RelatedPerson.photo.pages, RelatedPerson.period, RelatedPerson.period.extension, RelatedPerson.period.extension:period, RelatedPerson.period.start, RelatedPerson.period.end, RelatedPerson.communication, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension, RelatedPerson.communication.language, RelatedPerson.communication.preferred All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error RelatedPerson.meta.extension, RelatedPerson.meta.extension:meta, RelatedPerson.text.extension, RelatedPerson.text.extension:text, RelatedPerson.extension, RelatedPerson.modifierExtension, RelatedPerson.identifier.extension, RelatedPerson.identifier.extension:identifier, RelatedPerson.patient.extension, RelatedPerson.patient.extension:patient, RelatedPerson.relationship.extension, RelatedPerson.relationship.extension:relationship, RelatedPerson.name.extension, RelatedPerson.name.extension:name, RelatedPerson.telecom.extension, RelatedPerson.telecom.extension:telecom, RelatedPerson.address.extension, RelatedPerson.address.extension:address, RelatedPerson.photo.extension, RelatedPerson.photo.extension:photo, RelatedPerson.period.extension, RelatedPerson.period.extension:period, RelatedPerson.communication.extension, RelatedPerson.communication.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
txt-1 error RelatedPerson.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error RelatedPerson.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron