New Zealand rheumatic fever FHIR Implementation Guide
0.4.6 - draft
New Zealand rheumatic fever FHIR Implementation Guide
0.4.6 - draft
New Zealand rheumatic fever FHIR Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.4.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/rheumatic-fever/ and changes regularly. See the Directory of published versions
| Official URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/nz-rheumaticfever-patient | Version: 1.0.0 | |||
| Draft as of 2024-08-07 | Computable Name: RheumaticFeverPatient | |||
NzPatient-based FHIR resource for representing rheumatic fever patients
Profiles a New Zealand patient with rheumatic fever (extends NzPatient resource)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NzPatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Patient |
NzPatient | |||
  meta |
C | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
  Slices for extension |
Content/Rules for all slices | |||
   interpreterRequired |
0..* | boolean | Does this person require an interpreter? URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
| name |
1..1 | HumanName | A name associated with the patient | |
| contact |
||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  whanauMemberCareRole |
0..1 | Coding | Codifies role taken by a whanau member of patient's care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred) | |
| whanauMemberCareRelationship |
0..1 | string | Relationship of whanau member to patient in care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship | |
| whanauMemberCarePrimary |
0..1 | boolean | Denotes if the member is to be used a primary contact URL: https://build.fhir.org/ig/tewhatuora/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 | ||||
| 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 |
|---|---|---|---|---|
| Patient |
C | 0..* | NzPatient | Information about an individual or animal receiving health care services nz-pat-1: only a single official NHI |
 meta |
ΣC | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) |
| 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) | |
| interpreterRequired |
0..* | boolean | Does this person require an interpreter? 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 |
 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | |
| Patient.link.type | required | Pattern: seealsohttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
C | 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 |
ΣC | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) | ||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| 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) | |||||
| interpreterRequired |
0..* | boolean | Does this person require an interpreter? 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 | ||||
| telecom |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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 pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| whanauMemberCareRole |
0..1 | Coding | Codifies role taken by a whanau member of patient's care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred) | |||||
| whanauMemberCareRelationship |
0..1 | string | Relationship of whanau member to patient in care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship | |||||
| whanauMemberCarePrimary |
0..1 | boolean | Denotes if the member is to be used a primary contact URL: https://build.fhir.org/ig/tewhatuora/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.
| |||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
| Patient.identifier:NHI.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | Pattern: seealsohttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| 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' |
This structure is derived from NzPatient
Summary
Mandatory: 1 element
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from NzPatient
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient |
NzPatient | |||
| meta |
C | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
| Slices for extension |
Content/Rules for all slices | |||
| interpreterRequired |
0..* | boolean | Does this person require an interpreter? URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
| name |
1..1 | HumanName | A name associated with the patient | |
| contact |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| whanauMemberCareRole |
0..1 | Coding | Codifies role taken by a whanau member of patient's care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred) | |
| whanauMemberCareRelationship |
0..1 | string | Relationship of whanau member to patient in care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship | |
| whanauMemberCarePrimary |
0..1 | boolean | Denotes if the member is to be used a primary contact URL: https://build.fhir.org/ig/tewhatuora/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 | ||||
| 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' |
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 |
| meta |
ΣC | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) |
| 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) | |
| interpreterRequired |
0..* | boolean | Does this person require an interpreter? 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 |
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | |
| Patient.link.type | required | Pattern: seealsohttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| Patient |
C | 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 |
ΣC | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) | ||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| 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) | |||||
| interpreterRequired |
0..* | boolean | Does this person require an interpreter? 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 | ||||
| telecom |
C | 0..* | NzContactPoint | Details of a Technology mediated contact point (phone, fax, email, etc.) cpt-2: A system is required if a value is provided. | ||||
| gender |
Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate |
Σ | 0..1 | date | The date of birth for the individual | ||||
| deceased[x] |
?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
| deceasedBoolean |
boolean | |||||||
| deceasedDateTime |
dateTime | |||||||
| address |
0..* | NzAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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 pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| whanauMemberCareRole |
0..1 | Coding | Codifies role taken by a whanau member of patient's care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-role Binding: Rheumatic fever patient care team participant role codes (preferred) | |||||
| whanauMemberCareRelationship |
0..1 | string | Relationship of whanau member to patient in care team URL: https://build.fhir.org/ig/tewhatuora/rheumatic-fever/StructureDefinition/rf-patient-whanaumember-relationship | |||||
| whanauMemberCarePrimary |
0..1 | boolean | Denotes if the member is to be used a primary contact URL: https://build.fhir.org/ig/tewhatuora/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.
| |||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Patient.identifier:NHI.use | required | NHIUsehttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | ||||
| Patient.identifier:NHI.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | ||||
| Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.maritalStatus | extensible | Marital Status Codeshttp://hl7.org/fhir/ValueSet/marital-statusfrom the FHIR Standard | ||||
| Patient.contact.relationship | extensible | PatientContactRelationshiphttp://hl7.org/fhir/ValueSet/patient-contactrelationshipfrom the FHIR Standard | ||||
| Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| Patient.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Patient.link.type | required | Pattern: seealsohttp://hl7.org/fhir/ValueSet/link-type|4.0.1from the FHIR Standard |
| 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' |
This structure is derived from NzPatient
Summary
Mandatory: 1 element
Prohibited: 2 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron