New Zealand Rheumatic Fever FHIR Implementation Guide
0.4.9 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide
0.4.9 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v0.4.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-diagnosisgroup | Version: 1.0.0 | |||
| Draft as of 2024-08-22 | Computable Name: RheumaticFeverDiagnosisGroup | |||
This profile constrains the codes valid on an Observation so it can represent groups of rheumatic fever diagnosis data.
Constraints coding of a standard FHIR Observation for use in RF diagnosis representation
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Observation |
Observation | |||
  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) |
| contained |
0..0 | |||
  Slices for identifier |
0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use | |
   identifier:NationalSystem |
0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. | |
  id |
0..0 | |||
 extension |
0..0 | |||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | |
| system |
0..1 | uri | The namespace for the identifier value Example uri: https://standards.digital.health.nz/ns/rfccs | |
 value |
1..1 | string | The value that is unique Example RFCCS object id: OBS-0207 | |
| code |
1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) | |
| value[x] |
0..0 | |||
| specimen |
0..0 | |||
| device |
0..0 | |||
| referenceRange |
0..0 | |||
 hasMember |
0..1 | Reference(Observation) | Related resource that belongs to the Observation group | |
 component |
||||
 code |
1..1 | CodeableConcept | Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | |
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG | |
| Observation.component.code | required | RFDiagnosisObservationCodingValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
 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..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use |
| identifier:NationalSystem |
Σ | 0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. |
| extension |
0..0 | |||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207 |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code |
Σ | 1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) |
| hasMember |
Σ | 0..1 | Reference(Observation) | Related resource that belongs to the Observation group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
| 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) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use | ||||
| identifier:NationalSystem |
Σ | 0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. | ||||
| extension |
0..0 | |||||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207 | ||||
| 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) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
Σ | 1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) | ||||
| subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
 effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| hasMember |
Σ | 0..1 | Reference(Observation) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| 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 | ||||
| code |
Σ | 1..1 | CodeableConcept | Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required) | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | required | RFDiagnosisObservationCodingValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-codefrom this IG | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 Observation
Summary
Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Observation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Observation |
Observation | |||
| 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) |
| contained |
0..0 | |||
| Slices for identifier |
0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use | |
| identifier:NationalSystem |
0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. | |
| id |
0..0 | |||
| extension |
0..0 | |||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | |
| system |
0..1 | uri | The namespace for the identifier value Example uri: https://standards.digital.health.nz/ns/rfccs | |
| value |
1..1 | string | The value that is unique Example RFCCS object id: OBS-0207 | |
| code |
1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) | |
| value[x] |
0..0 | |||
| specimen |
0..0 | |||
| device |
0..0 | |||
| referenceRange |
0..0 | |||
| hasMember |
0..1 | Reference(Observation) | Related resource that belongs to the Observation group | |
| component |
||||
| code |
1..1 | CodeableConcept | Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | |
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG | |
| Observation.component.code | required | RFDiagnosisObservationCodingValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 |
|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present |
| 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..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier |
Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use |
| identifier:NationalSystem |
Σ | 0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. |
| extension |
0..0 | |||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual |
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) |
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207 |
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. |
| code |
Σ | 1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) |
| hasMember |
Σ | 0..1 | Reference(Observation) | Related resource that belongs to the Observation group |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Observation.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | |
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | |
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 | ||||
|---|---|---|---|---|---|---|---|---|
| Observation |
C | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present | ||||
| 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) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier |
Σ | 0..* | Identifier | Business Identifier for observation Slice: Unordered, Open by value:use | ||||
| identifier:NationalSystem |
Σ | 0..* | Identifier | This identifier is used to sync the FHIR Observation instance with its national system (RFCCS) record. | ||||
| extension |
0..0 | |||||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
| type |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient Example uri: https://standards.digital.health.nz/ns/rfccs | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 Example RFCCS object id: OBS-0207 | ||||
| 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) | ||||
| basedOn |
Σ | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | Fulfills plan, proposal or order | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required): Codes providing the status of an observation. | ||||
| category |
0..* | CodeableConcept | Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories. | |||||
| code |
Σ | 1..1 | CodeableConcept | For rheumatic fever data, must be one of three diagnosis group codes Binding: Codes for rheumatic fever diagnosis observation grouping (required) | ||||
| subject |
Σ | 0..1 | Reference(Patient | Group | Device | Location) | Who and/or what the observation is about | ||||
| focus |
Σ | 0..* | Reference(Resource) | What the observation is about, when it is not about the subject of record | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | ||||
| effective[x] |
Σ | 0..1 | Clinically relevant time/time-period for observation | |||||
| effectiveDateTime |
dateTime | |||||||
| effectivePeriod |
Period | |||||||
| effectiveTiming |
Timing | |||||||
| effectiveInstant |
instant | |||||||
| issued |
Σ | 0..1 | instant | Date/Time this version was made available | ||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | Who is responsible for the observation | ||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| note |
0..* | Annotation | Comments about the observation | |||||
| bodySite |
0..1 | CodeableConcept | Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| method |
0..1 | CodeableConcept | How it was done Binding: ObservationMethods (example): Methods for simple observations. | |||||
| hasMember |
Σ | 0..1 | Reference(Observation) | Related resource that belongs to the Observation group | ||||
| derivedFrom |
Σ | 0..* | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) | Related measurements the observation is made from | ||||
| component |
Σ | 0..* | BackboneElement | Component results | ||||
| 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 | ||||
| code |
Σ | 1..1 | CodeableConcept | Code must uniquely identify component within the Observation group, and be drawn from the RF NZ diagnosis ValueSet Binding: Codes for component observations of NZ rheumatic fever diagnosis (required) | ||||
| value[x] |
Σ | 0..1 | Actual component result | |||||
| valueQuantity |
Quantity | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueString |
string | |||||||
| valueBoolean |
boolean | |||||||
| valueInteger |
integer | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueSampledData |
SampledData | |||||||
| valueTime |
time | |||||||
| valueDateTime |
dateTime | |||||||
| valuePeriod |
Period | |||||||
| dataAbsentReason |
C | 0..1 | CodeableConcept | Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing. | ||||
| interpretation |
0..* | CodeableConcept | High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations. | |||||
| referenceRange |
0..* | See referenceRange (Observation) | Provides guide for interpretation of component result | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Observation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Observation.identifier:NationalSystem.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | ||||
| Observation.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG | ||||
| Observation.status | required | ObservationStatushttp://hl7.org/fhir/ValueSet/observation-status|4.0.1from the FHIR Standard | ||||
| Observation.category | preferred | ObservationCategoryCodeshttp://hl7.org/fhir/ValueSet/observation-categoryfrom the FHIR Standard | ||||
| Observation.code | required | RFDiagnosisGroupValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosisgroup-codefrom this IG | ||||
| Observation.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard | ||||
| Observation.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| Observation.method | example | ObservationMethodshttp://hl7.org/fhir/ValueSet/observation-methodsfrom the FHIR Standard | ||||
| Observation.referenceRange.type | preferred | ObservationReferenceRangeMeaningCodeshttp://hl7.org/fhir/ValueSet/referencerange-meaningfrom the FHIR Standard | ||||
| Observation.referenceRange.appliesTo | example | ObservationReferenceRangeAppliesToCodeshttp://hl7.org/fhir/ValueSet/referencerange-appliestofrom the FHIR Standard | ||||
| Observation.component.code | required | RFDiagnosisObservationCodingValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/rf-observation-diagnosis-component-codefrom this IG | ||||
| Observation.component.dataAbsentReason | extensible | DataAbsentReasonhttp://hl7.org/fhir/ValueSet/data-absent-reasonfrom the FHIR Standard | ||||
| Observation.component.interpretation | extensible | ObservationInterpretationCodeshttp://hl7.org/fhir/ValueSet/observation-interpretationfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| RFNZTagConstraint | error | Observation.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 Observation
Summary
Mandatory: 0 element(3 nested mandatory elements)
Prohibited: 7 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron