Digital Child Health Service - Events Catalogue

DCH-RelatedPerson-1

This RelatedPerson resource has been constrained to represent a person related to the patient subject to the Child Health Event.

NameCard.TypeDescription & Constraints
..RelatedPersonDomainResourceAn person that is related to a patient, but who is not a direct target of care

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...householdMember1..1ExtensionHousehold member information for a related person
...link0..1ExtensionA link to a Patient resource for a Related Person
...identifier1..1IdentifierA human identifier for this person

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

.....coding0..*CodingCode defined by a terminology system

......id0..1Idxml:id (or equivalent in JSON)

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

.....text0..1StringPlain text representation of the concept

....system1..1UriThe namespace for the identifier
Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

....value1..1StringThe value that is unique
Example Value 123456

....period0..1PeriodTime period when id is/was valid for use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner0..1Reference (CareConnect-DCH-Organization-1)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

...patient1..1Reference (CareConnect-DCH-Patient-1)The patient this person is related to

....id0..1Idxml:id (or equivalent in JSON)

....reference1..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...relationship1..1CodeableConceptThe nature of the relationship
Binding The nature of the relationship between a patient and the related person (http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype)
Binding Strength Required

....id0..1Idxml:id (or equivalent in JSON)

....coding1..1CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system

.....version0..1StringVersion of the system - if relevant

.....code1..1CodeSymbol in syntax defined by the system

.....display1..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...name1..1HumanNameA name associated with the person

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codeusual | official | temp | nickname | anonymous | old | maiden
Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use)
Binding Strength Required

....text0..1StringText representation of the full name

....family1..1StringFamily name (often called 'Surname')

....given1..1StringGiven names (not always 'first'). Includes middle names

....prefix0..*StringParts that come before the name

....suffix0..*StringParts that come after the name

....period0..1PeriodTime period when name was/is in use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...telecom0..1ContactPointA contact detail for the person

....id0..1Idxml:id (or equivalent in JSON)

....system0..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required

....value0..1StringThe actual contact point details

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required

....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

....period0..1PeriodTime period when the contact point was/is in use

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...gender1..1Codemale | female | other | unknown
Binding The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1)
Binding Strength Required

...birthDate1..1DateThe date on which the related person was born

...address0..1AddressAddress where the related person can be contacted or visited

....id0..1Idxml:id (or equivalent in JSON)

....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value home

....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

....text0..1StringText representation of the address
Example Value 137 Nowhere Street, Erewhon 9132

....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 137 Nowhere Street

....city0..1StringName of city, town etc.
Example Value Erewhon

....district0..1StringDistrict name (aka county)
Example Value Madison

....state0..1StringSub-unit of country (abbreviations ok)

....postalCode0..1StringPostal code for area
Example Value 9132

....country0..1StringCountry (can be ISO 3166 3 letter code)

....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

.....id0..1Idxml:id (or equivalent in JSON)

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...photo0..1AttachmentImage of the person

....id0..1Idxml:id (or equivalent in JSON)

....contentType0..1CodeMime type of the content, with charset etc.
Binding The mime type of an attachment. Any valid mime type is allowed. (http://www.rfc-editor.org/bcp/bcp13.txt)
Binding Strength Required
Example Value text/plain; charset=UTF-8, image/png

....language0..1CodeHuman language of the content (BCP-47)
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required
Example Value en-AU

....data0..1Base64BinaryData inline, base64ed

....url0..1UriUri where the data can be found
Example Value http://www.acme.com/logo-small.png

....size0..1UnsignedIntNumber of bytes of content (if url provided)

....hash0..1Base64BinaryHash of the data (sha-1, base64ed)

....title0..1StringLabel to display in place of the data
Example Value Official Corporate Logo

....creation0..1DateTimeDate attachment was first created

...period0..1PeriodPeriod of time that this relationship is considered valid

....id0..1Idxml:id (or equivalent in JSON)

....start0..1DateTimeStarting time with inclusive boundary

....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

Name Type Description & Constraints
. . Extension-DCH-HouseholdMember-1 Extension This extension has been constrained to represent the household member information for a person related to the patient subject to the Child Health Event.
. . Extension-DCH-Link-1 Extension This extension has been constrained to represent a link to a Patient resource for a Related Person.
Path Name Binding Strength ValueSet
.RelatedPerson.language language Required http://tools.ietf.org/html/bcp47
.RelatedPerson.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.RelatedPerson.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.RelatedPerson.relationship relationship Required http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
.RelatedPerson.name.use use Required http://hl7.org/fhir/ValueSet/name-use
.RelatedPerson.telecom.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.RelatedPerson.telecom.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.RelatedPerson.gender gender Required https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1
.RelatedPerson.address.use use Required http://hl7.org/fhir/ValueSet/address-use
.RelatedPerson.address.type type Required http://hl7.org/fhir/ValueSet/address-type
.RelatedPerson.photo.contentType contentType Required http://www.rfc-editor.org/bcp/bcp13.txt