New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Rheumatic Fever Patient

NzPatient-based FHIR resource for representing rheumatic fever patients

Profiles a New Zealand patient with rheumatic fever (extends NzPatient resource)

Usages:

• Refer to this Profile: Rheumatic Fever CarePlan and Rheumatic Fever Condition
• Examples for this Profile: Patient/PaniaPunga, Patient/SageWestbrook and Patient/SageWestbrookAndWhanau
• CapabilityStatements using this Profile: Rheumatic Fever FHIR API Capability Statement

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.link.type	required	Pattern Value: seealso http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	error	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			NzPatient
meta	C	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
implicitRules		0..0
language		0..0
name		1..1	HumanName	A name associated with the patient
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:whanauMemberCareRole		0..1	Coding	Codifies role taken by a whanau member of patient's care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred)
extension:whanauMemberCareRelationship		0..1	string	Relationship of whanau member to patient in care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
extension:whanauMemberCarePrimary		0..1	boolean	Denotes if the member is to be used a primary contact URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary
link
other		1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type		1..1	code	replaced-by | replaces | refer | seealso Required Pattern: seealso
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	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 patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
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..*	NzContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
address	Σ	0..*	NzAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:whanauMemberCareRole		0..1	Coding	Codifies role taken by a whanau member of patient's care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred)
extension:whanauMemberCareRelationship		0..1	string	Relationship of whanau member to patient in care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
extension:whanauMemberCarePrimary		0..1	boolean	Denotes if the member is to be used a primary contact URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	Pattern Value: seealso http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	error	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 1 element
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role
• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
Slices for extension				Content/Rules for all slices
extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
Slices for extension				Content/Rules for all slices
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.link.type	required	Pattern Value: seealso http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	error	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2

Differential View

This structure is derived from NzPatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient			NzPatient
meta	C	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
implicitRules		0..0
language		0..0
name		1..1	HumanName	A name associated with the patient
contact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:whanauMemberCareRole		0..1	Coding	Codifies role taken by a whanau member of patient's care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred)
extension:whanauMemberCareRelationship		0..1	string	Relationship of whanau member to patient in care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
extension:whanauMemberCarePrimary		0..1	boolean	Denotes if the member is to be used a primary contact URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary
link
other		1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type		1..1	code	replaced-by | replaces | refer | seealso Required Pattern: seealso
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services Constraints: nz-pat-1
id	Σ	0..1	id	Logical id of this artifact
meta	ΣC	0..1	Meta	Metadata about the resource Constraints: RFNZTagConstraint
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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (L4) (preferred)
extension:nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
extension:dhb		0..1	CodeableConcept	District Health Board linked to a NZ Healthcare Service, Location or Patient URL: http://hl7.org.nz/fhir/StructureDefinition/dhb Binding: District Health Board Identifer (extensible): NZ HPI-ORG Values for DHBs
extension:domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
extension:pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
extension:sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
extension:iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
extension:acc-patient-occupation		0..1	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/acc-patient-occupation Binding: ACC Patient Occupation (example)
extension:messaging-address		0..*	(Complex)	Messaging Address URL: http://hl7.org.nz/fhir/StructureDefinition/messaging-address
extension:nz-residency		0..1	(Complex)	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-residency
extension:interpreter-required		0..1	boolean	Whether an interpreter is required URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:NHI	Σ	0..*	Identifier	An identifier for this patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id
value	Σ	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 patient's record is in active use
name	Σ	1..1	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
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..*	NzContactPoint	A contact detail for the individual
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:genderOriginalText		0..1	string	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/gender-original-text
value		0..1	string	Primitive value for code
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedDateTime	?!Σ	0..1	dateTime	Indicates if the individual is deceased or not
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:information-source		0..1	CodeableConcept	Information Source URL: http://hl7.org.nz/fhir/StructureDefinition/information-source Binding: Information Source (preferred)
value		0..1	dateTime	Primitive value for dateTime
address	Σ	0..*	NzAddress	An address for the individual
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:whanauMemberCareRole		0..1	Coding	Codifies role taken by a whanau member of patient's care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred)
extension:whanauMemberCareRelationship		0..1	string	Relationship of whanau member to patient in care team URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
extension:whanauMemberCarePrimary		0..1	boolean	Denotes if the member is to be used a primary contact URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. Required Pattern: seealso
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:NHI.use	required	NHIUse https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	Pattern Value: seealso http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
RFNZTagConstraint	error	Patient.meta	All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz'
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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	error	Patient	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	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
nz-pat-1	error	Patient	only a single official NHI : Patient.identifier.where(system='https://standards.digital.health.nz/ns/nhi-id' and use='official').count() < 2
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from NzPatient

Summary

Mandatory: 1 element
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role
• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship
• https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-primary

Other representations of profile: CSV, Excel, Schematron