Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Rheumatic Fever Patient

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-rheumaticfever-patient Version: 1.0.0
Active as of 2024-03-22 Computable Name: RheumaticFeverPatient

NzPatient-based FHIR resource for representing rheumatic fever patients

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

Warning: The IG official Url will be changing

The official Url of this Implementation Guide is expected to change in early 2024.

The Url domain will move to digital.health.nz and the IG will likely be renamed.

Developers of applications that consume this API are advised to make the official Url base configurable in their applications – the base Url is currently https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/


Usage:

Formal Views of Profile Content

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

This structure is derived from NzPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NzPatient
... implicitRules 0..0
... language 0..0
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... contact
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... whanauMemberCareRole 0..1CodingCodifies role taken by a whanau member of patient's care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-role
Binding: Rheumatic fever patient care team participant role codes (required)
.... whanauMemberCareRelationship 0..1stringRelationship of whanau member to patient in care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-relationship
.... whanauMemberCarePrimary 0..1booleanDenotes if the member is to be used a primary contact
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-primary
... link
.... other 1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type 1..1codereplaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*NzPatientInformation about an individual or animal receiving health care services
nz-pat-1: only a single official NHI
... ethnicity 0..*CodeableConceptNZ 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..1CodeableConceptDistrict 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


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


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... iwi 0..*CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NHI Σ0..*IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..1HumanNameA name associated with the patient
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.link.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*NzPatientInformation about an individual or animal receiving health care services
nz-pat-1: only a single official NHI
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicity 0..*CodeableConceptNZ 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..1CodeableConceptDistrict 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..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... iwi 0..*CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NHI Σ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..1HumanNameA name associated with the patient
... telecom C0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... whanauMemberCareRole 0..1CodingCodifies role taken by a whanau member of patient's care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-role
Binding: Rheumatic fever patient care team participant role codes (required)
.... whanauMemberCareRelationship 0..1stringRelationship of whanau member to patient in care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-relationship
.... whanauMemberCarePrimary 0..1booleanDenotes if the member is to be used a primary contact
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-primary
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Differential View

This structure is derived from NzPatient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient NzPatient
... implicitRules 0..0
... language 0..0
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... contact
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... whanauMemberCareRole 0..1CodingCodifies role taken by a whanau member of patient's care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-role
Binding: Rheumatic fever patient care team participant role codes (required)
.... whanauMemberCareRelationship 0..1stringRelationship of whanau member to patient in care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-relationship
.... whanauMemberCarePrimary 0..1booleanDenotes if the member is to be used a primary contact
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-primary
... link
.... other 1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type 1..1codereplaced-by | replaces | refer | seealso
Required Pattern: seealso

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*NzPatientInformation about an individual or animal receiving health care services
nz-pat-1: only a single official NHI
... ethnicity 0..*CodeableConceptNZ 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..1CodeableConceptDistrict 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


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


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... iwi 0..*CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NHI Σ0..*IdentifierAn identifier for this patient
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..1HumanNameA name associated with the patient
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.link.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*NzPatientInformation about an individual or animal receiving health care services
nz-pat-1: only a single official NHI
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ethnicity 0..*CodeableConceptNZ 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..1CodeableConceptDistrict 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..1CodeableConceptNZ Domicile Code
URL: http://hl7.org.nz/fhir/StructureDefinition/domicile-code
Binding: Domicile Code (preferred)
... pho 0..1CodeableConceptPrimary Healthcare Organisation
URL: http://hl7.org.nz/fhir/StructureDefinition/pho
Binding: PHO (extensible): NZ HPI-ORG Values for PHOs


... sex-at-birth 0..1CodeableConceptSex At Birth
URL: http://hl7.org.nz/fhir/StructureDefinition/sex-at-birth
Binding: AdministrativeGender (required)
... iwi 0..*CodeableConceptExtension
URL: http://hl7.org.nz/fhir/StructureDefinition/nz-iwi
Binding: Iwi (preferred)
... interpreterRequired 0..*booleanDoes this person require an interpreter?
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierAn identifier for this patient
Slice: Unordered, Open by value:system
.... identifier:NHI Σ0..*IdentifierAn identifier for this patient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ0..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name Σ1..1HumanNameA name associated with the patient
... telecom C0..*NzContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
cpt-2: A system is required if a value is provided.
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address 0..*NzAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementA 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..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... whanauMemberCareRole 0..1CodingCodifies role taken by a whanau member of patient's care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-role
Binding: Rheumatic fever patient care team participant role codes (required)
.... whanauMemberCareRelationship 0..1stringRelationship of whanau member to patient in care team
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-relationship
.... whanauMemberCarePrimary 0..1booleanDenotes if the member is to be used a primary contact
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-patient-whanaumember-primary
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


Required Pattern: seealso

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Patient.identifier:NHI.userequiredNHIUse
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
Patient.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleMarital Status Codes
http://hl7.org/fhir/ValueSet/marital-status
from the FHIR Standard
Patient.contact.relationshipextensiblePatientContactRelationship
http://hl7.org/fhir/ValueSet/patient-contactrelationship
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.link.typerequiredPattern: seealso
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron