Rheumatic Fever Patient - Testing IG v0.0.1

0..*

NzPatient

Information about an individual or animal receiving health care services
nz-pat-1: only a single official NHI

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

text

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

ethnicity

0..*

NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)

nzCitizen

0..1

(Complex)

Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship

dhb

0..1

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

domicile-code

0..1

NZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)

pho

0..1

Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

sex-at-birth

0..1

Sex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)

iwi

0..*

Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)

?!

0..*

Extensions that cannot be ignored

Slices for identifier

Σ

0..*

An identifier for this patient
Slice: Unordered, Open by value:system

identifier:NHI

Σ

0..*

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)

Σ

0..1

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

The value that is unique
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

Σ

1..1

A name associated with the patient

0..*

NzContactPoint

Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.

Σ

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

birthDate

Σ

0..1

date

The date of birth for the individual

deceased[x]

?!Σ

0..1

Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

0..*

An address expressed using postal conventions (as opposed to GPS or other location definition formats)

maritalStatus

0..1

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

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

ContactPoint

A contact detail for the person

address

0..1

Address

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

language

1..1

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

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

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

Σ

1..1

Documentation for this format

replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

Required Pattern: seealso

Terminology Bindings

Path Conformance ValueSet / Code URI

Patient.identifier:NHI.use

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.gender

PatientContactRelationship

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

http://hl7.org/fhir/ValueSet/patient-contactrelationship

from the FHIR Standard

Patient.contact.gender

AdministrativeGender

http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1

from the FHIR Standard

Patient.communication.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Patient.link.type

Description & Constraints

Pattern: seealso

http://hl7.org/fhir/ValueSet/link-type|4.0.1

from the FHIR Standard

This structure is derived from NzPatient

Differential View

This structure is derived from NzPatient

Name	Card.	Type	Description & Constraints
Patient	0..*	NzPatient	Information about an individual or animal receiving health care services
implicitRules	0..0
language	0..0
name	1..1	HumanName	A name associated with the patient
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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	NzPatient	Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI
Slices for extension				Content/Rules for all slices
ethnicity		0..*	CodeableConcept	NZ Ethnicity URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity Binding: Ethnicity of a person (preferred)
nzCitizen		0..1	(Complex)	Is this person a New Zealand citizen URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship
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
domicile-code		0..1	CodeableConcept	NZ Domicile Code URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code Binding: Domicile Code (preferred)
pho		0..1	CodeableConcept	Primary Healthcare Organisation URL: http://hl7.org.nz/fhir/StructureDefinition/pho Binding: PHO (extensible): NZ HPI-ORG Values for PHOs
sex-at-birth		0..1	CodeableConcept	Sex At Birth URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth Binding: AdministrativeGender (required)
iwi		0..*	CodeableConcept	Extension URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi Binding: Iwi (preferred)
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
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
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.link.type	required	Pattern: seealso `http://hl7.org/fhir/ValueSet/link-type\|4.0.1` from the FHIR Standard

Snapshot View

Patient

0..*

NzPatient

Information about an individual or animal receiving health care services
nz-pat-1: only a single official NHI

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

text

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..*

Resource

Contained, inline Resources

Slices for extension

0..*

Extension
Slice: Unordered, Open by value:url

ethnicity

0..*

NZ Ethnicity
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-ethnicity
Binding: Ethnicity of a person (preferred)

nzCitizen

0..1

(Complex)

Is this person a New Zealand citizen
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-citizenship

dhb

0..1

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

domicile-code

0..1

NZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)

pho

0..1

Primary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs

sex-at-birth

0..1

Sex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)

iwi

0..*

Extension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)

?!

0..*

Extensions that cannot be ignored

Slices for identifier

Σ

0..*

An identifier for this patient
Slice: Unordered, Open by value:system

identifier:NHI

Σ

0..*

An identifier for this patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

use

?!Σ

0..1

usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)

Σ

0..1

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

The value that is unique
Example General: 123456

Σ

0..1

Time period when id is/was valid for use

assigner

Σ

0..1

Organization that issued id (may be just text)

active

?!Σ

0..1

Whether this patient's record is in active use

Σ

1..1

A name associated with the patient

0..*

NzContactPoint

Details of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.

Σ

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

birthDate

Σ

0..1

date

The date of birth for the individual

deceased[x]

?!Σ

0..1

Indicates if the individual is deceased or not

deceasedBoolean

deceasedDateTime

0..*

An address expressed using postal conventions (as opposed to GPS or other location definition formats)

maritalStatus

0..1

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

multipleBirthInteger

integer

photo

0..*

Image of the patient

0..*

A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

relationship

0..*

The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.

0..1

A name associated with the contact person

0..*

ContactPoint

A contact detail for the person

address

0..1

Address

Address for the contact person

0..1

male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

organization

0..1

Organization that is associated with the contact

0..1

The period during which this contact person or organization is valid to be contacted relating to this patient

communication

0..*

A language which may be used to communicate with the patient about his or her health

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

language

1..1

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

0..1

Language preference indicator

generalPractitioner

0..*

Reference(Organization | Practitioner | PractitionerRole)

Patient's nominated primary care provider

managingOrganization

Σ

0..1

Organization that is the custodian of the patient record

link

?!Σ

0..*

Link to another patient resource that concerns the same actual person

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

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

Σ

1..1