This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
DSTU
1).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
| Abstract Types | ||
| Element | XML | JSON |
| BackBoneElement | XML | JSON |
| Resource | XML | JSON |
| DomainResource | XML | JSON |
| Primitive Types | ||
| base64Binary | XML | JSON |
| boolean | XML | JSON |
| code | XML | JSON |
| date | XML | JSON |
| dateTime | XML | JSON |
| decimal | XML | JSON |
| id | XML | JSON |
| instant | XML | JSON |
| integer | XML | JSON |
| oid | XML | JSON |
| string | XML | JSON |
| time | XML | JSON |
| uri | XML | JSON |
| uuid | XML | JSON |
| Data Types | ||
| Address | XML | JSON |
| Attachment | XML | JSON |
| BackboneElement | XML | JSON |
| CodeableConcept | XML | JSON |
| Coding | XML | JSON |
| ContactPoint | XML | JSON |
| Element | XML | JSON |
| ElementDefinition | XML | JSON |
| Extension | XML | JSON |
| HumanName | XML | JSON |
| Identifier | XML | JSON |
| Meta | XML | JSON |
| Narrative | XML | JSON |
| Period | XML | JSON |
| Quantity | XML | JSON |
| Range | XML | JSON |
| Ratio | XML | JSON |
| Reference | XML | JSON |
| SampledData | XML | JSON |
| Signature | XML | JSON |
| Timing | XML | JSON |
| FHIR Specification Core | ||
| 11179-objectClass Object Class | XML | JSON |
| 11179-objectClassProperty Object Class Property | XML | JSON |
| 11179-permitted-value-conceptmap Mapping from permitted to transmitted | XML | JSON |
| 11179-permitted-value-valueset Permitted values | XML | JSON |
| alert-period Time period when alert is active | XML | JSON |
| allergyintolerance-reasonRefuted Explanation associated with refuted status | XML | JSON |
| allergyintolerance-resolutionAge Age that the allergy or intolerance resolved | XML | JSON |
| birthPlace Place of Birth for patient | XML | JSON |
| communication-reasonNotPerformed Why the communication was not or could not be carried out | XML | JSON |
| communicationrequest-orderedBy Agent that ordered the communication. | XML | JSON |
| communicationrequest-reasonRejected Why the recipient could not be act upon the request | XML | JSON |
| composition-clindoc-otherConfidentiality Additional confidentiality codes | XML | JSON |
| condition-contributionToDeath Whether the problem was a factor in death | XML | JSON |
| condition-criticality Potential impact of the condition | XML | JSON |
| conformance-common-expectation Conformance expectation | XML | JSON |
| conformance-common-prohibited Functionality not allowed | XML | JSON |
| conformance-common-supported-system Code system not defined in a value set | XML | JSON |
| data-absent-reason Why a value is missing | XML | JSON |
| datadictionary Associates the structure definition with a collection of Data Elements | XML | JSON |
| deviceuserequest-reasonRejected If request was rejected, why? | XML | JSON |
| diagnosticReport-locationPerformed Location Performed | XML | JSON |
| diagnosticorder-precondition The condition or state of the patient for this test | XML | JSON |
| diagnosticorder-reason Reason for this order | XML | JSON |
| diagnosticorder-reasonRejected The reason the order was rejected | XML | JSON |
| elementdefinition-allowedUnits Units to use for measured value | XML | JSON |
| elementdefinition-identifier External Identifier associated with this element | XML | JSON |
| elementdefinition-maxValueSet Maximum Value Set (when strength = extensible) | XML | JSON |
| elementdefinition-question Prompt for element phrased as question | XML | JSON |
| encounter-admission Time of admission | XML | JSON |
| encounter-associatedEncounter Associated Encounter | XML | JSON |
| encounter-condition A condition related to this encounter | XML | JSON |
| encounter-conditionRole The role of the condition | XML | JSON |
| encounter-discharge Time of discharge | XML | JSON |
| encounter-primaryCondition Condition driving this encounter | XML | JSON |
| encounter-reasonCancelled Explanation for cancellation | XML | JSON |
| encounter-relatedCondition Other associated conditions | XML | JSON |
| entryFormat User prompt for format | XML | JSON |
| familyhistory-abatement When (or if) the family member's condition resolved | XML | JSON |
| familyhistory-didNotHave Indicates the condition was not present in the family member | XML | JSON |
| familyhistory-gender Gender of the family relation | XML | JSON |
| familyhistory-patient-record Link to patient record | XML | JSON |
| familyhistory-severity The seriousness of the family member condition | XML | JSON |
| genetics-relationObservation Genetic markers, ethnicity, etc. | XML | JSON |
| genetics-relationParent Mother(s) & Father(s) - genetic & other | XML | JSON |
| geneticsAlleleName AlleleName | XML | JSON |
| geneticsAllelicState AllelicState | XML | JSON |
| geneticsAminoAcidChange HGVSproteinChange | XML | JSON |
| geneticsAminoAcidChangeType ProteinChangeType | XML | JSON |
| geneticsAssessedCondition AssessedCondition | XML | JSON |
| geneticsCIGAR CIGAR | XML | JSON |
| geneticsChromosome Chr | XML | JSON |
| geneticsDNARegionName RegionName | XML | JSON |
| geneticsDNASequenceVariation HGVSdnaVariant | XML | JSON |
| geneticsDNASequenceVariationType DNAvariantType | XML | JSON |
| geneticsGeneId HGNCgene | XML | JSON |
| geneticsGeneticsComment GeneticsComment | XML | JSON |
| geneticsGeneticsLaboratory GeneticsLab | XML | JSON |
| geneticsGeneticsPatientId GeneticsPtId | XML | JSON |
| geneticsGeneticsSpecimenId GeneticsSpecId | XML | JSON |
| geneticsGenomeBuild GenomeBuild | XML | JSON |
| geneticsGenomicReferenceSequenceId GenomicRefSeqID | XML | JSON |
| geneticsGenomicSourceClass GenomicSource | XML | JSON |
| geneticsGenomicStart GenomicStart | XML | JSON |
| geneticsGenomicStop GenomicStop | XML | JSON |
| geneticsObservedAllele ObsAllele | XML | JSON |
| geneticsProteinReferenceSequenceId ProteinReferenceSeq | XML | JSON |
| geneticsReferenceAllele RefAllele | XML | JSON |
| geneticsSpecies Species | XML | JSON |
| geneticsTranscriptReferenceSequenseId TransReferenceSeqID | XML | JSON |
| geneticsVariationId VariantId | XML | JSON |
| goal-category Code describing the type of goal | XML | JSON |
| goal-detail The target value range to be achieved | XML | JSON |
| goal-effectiveTime The effective time period for the goal | XML | JSON |
| goal-measure The parameter whose value is being tracked | XML | JSON |
| goal-reasonRejected The reason the goal was not accepted | XML | JSON |
| goal-target Target for goal | XML | JSON |
| http-response-header Http header returned by the interaction | XML | JSON |
| 11179-objectClass Object Class | XML | JSON |
| 11179-objectClassProperty Object Class Property | XML | JSON |
| 11179-permitted-value-conceptmap Mapping from permitted to transmitted | XML | JSON |
| 11179-permitted-value-valueset Permitted values | XML | JSON |
| alert-period Time period when alert is active | XML | JSON |
| allergyintolerance-reasonRefuted Explanation associated with refuted status | XML | JSON |
| allergyintolerance-resolutionAge Age that the allergy or intolerance resolved | XML | JSON |
| birthPlace Place of Birth for patient | XML | JSON |
| communication-reasonNotPerformed Why the communication was not or could not be carried out | XML | JSON |
| communicationrequest-orderedBy Agent that ordered the communication. | XML | JSON |
| communicationrequest-reasonRejected Why the recipient could not be act upon the request | XML | JSON |
| composition-clindoc-otherConfidentiality Additional confidentiality codes | XML | JSON |
| condition-contributionToDeath Whether the problem was a factor in death | XML | JSON |
| condition-criticality Potential impact of the condition | XML | JSON |
| conformance-common-expectation Conformance expectation | XML | JSON |
| conformance-common-prohibited Functionality not allowed | XML | JSON |
| conformance-common-supported-system Code system not defined in a value set | XML | JSON |
| data-absent-reason Why a value is missing | XML | JSON |
| datadictionary Associates the structure definition with a collection of Data Elements | XML | JSON |
| deviceuserequest-reasonRejected If request was rejected, why? | XML | JSON |
| diagnosticReport-locationPerformed Location Performed | XML | JSON |
| diagnosticorder-precondition The condition or state of the patient for this test | XML | JSON |
| diagnosticorder-reason Reason for this order | XML | JSON |
| diagnosticorder-reasonRejected The reason the order was rejected | XML | JSON |
| elementdefinition-allowedUnits Units to use for measured value | XML | JSON |
| elementdefinition-identifier External Identifier associated with this element | XML | JSON |
| elementdefinition-maxValueSet Maximum Value Set (when strength = extensible) | XML | JSON |
| elementdefinition-question Prompt for element phrased as question | XML | JSON |
| encounter-admission Time of admission | XML | JSON |
| encounter-associatedEncounter Associated Encounter | XML | JSON |
| encounter-condition A condition related to this encounter | XML | JSON |
| encounter-conditionRole The role of the condition | XML | JSON |
| encounter-discharge Time of discharge | XML | JSON |
| encounter-primaryCondition Condition driving this encounter | XML | JSON |
| encounter-reasonCancelled Explanation for cancellation | XML | JSON |
| encounter-relatedCondition Other associated conditions | XML | JSON |
| entryFormat User prompt for format | XML | JSON |
| familyhistory-abatement When (or if) the family member's condition resolved | XML | JSON |
| familyhistory-didNotHave Indicates the condition was not present in the family member | XML | JSON |
| familyhistory-gender Gender of the family relation | XML | JSON |
| familyhistory-patient-record Link to patient record | XML | JSON |
| familyhistory-severity The seriousness of the family member condition | XML | JSON |
| genetics-relationObservation Genetic markers, ethnicity, etc. | XML | JSON |
| genetics-relationParent Mother(s) & Father(s) - genetic & other | XML | JSON |
| geneticsAlleleName AlleleName | XML | JSON |
| geneticsAllelicState AllelicState | XML | JSON |
| geneticsAminoAcidChange HGVSproteinChange | XML | JSON |
| geneticsAminoAcidChangeType ProteinChangeType | XML | JSON |
| geneticsAssessedCondition AssessedCondition | XML | JSON |
| geneticsCIGAR CIGAR | XML | JSON |
| geneticsChromosome Chr | XML | JSON |
| geneticsDNARegionName RegionName | XML | JSON |
| geneticsDNASequenceVariation HGVSdnaVariant | XML | JSON |
| geneticsDNASequenceVariationType DNAvariantType | XML | JSON |
| geneticsGeneId HGNCgene | XML | JSON |
| geneticsGeneticsComment GeneticsComment | XML | JSON |
| geneticsGeneticsLaboratory GeneticsLab | XML | JSON |
| geneticsGeneticsPatientId GeneticsPtId | XML | JSON |
| geneticsGeneticsSpecimenId GeneticsSpecId | XML | JSON |
| geneticsGenomeBuild GenomeBuild | XML | JSON |
| geneticsGenomicReferenceSequenceId GenomicRefSeqID | XML | JSON |
| geneticsGenomicSourceClass GenomicSource | XML | JSON |
| geneticsGenomicStart GenomicStart | XML | JSON |
| geneticsGenomicStop GenomicStop | XML | JSON |
| geneticsObservedAllele ObsAllele | XML | JSON |
| geneticsProteinReferenceSequenceId ProteinReferenceSeq | XML | JSON |
| geneticsReferenceAllele RefAllele | XML | JSON |
| geneticsSpecies Species | XML | JSON |
| geneticsTranscriptReferenceSequenseId TransReferenceSeqID | XML | JSON |
| geneticsVariationId VariantId | XML | JSON |
| goal-category Code describing the type of goal | XML | JSON |
| goal-detail The target value range to be achieved | XML | JSON |
| goal-effectiveTime The effective time period for the goal | XML | JSON |
| goal-measure The parameter whose value is being tracked | XML | JSON |
| goal-reasonRejected The reason the goal was not accepted | XML | JSON |
| goal-target Target for goal | XML | JSON |
| http-response-header Http header returned by the interaction | XML | JSON |
| imagingstudy-radiationDose The amount of radiation, as a range | XML | JSON |
| imagingstudy-radiationDuration The length of time for radiation exposure | XML | JSON |
| immunization-protocol What protocol was followed | XML | JSON |
| immunization-reaction Details of a reaction that follows immunization | XML | JSON |
| immunization-reported True if this administration was reported | XML | JSON |
| indirectTarget target if different from the subject. | XML | JSON |
| iso21090-AD-use BAD | CONF | HP | HV | DIR | PUB | PHYS | PST | XML | JSON |
| iso21090-ADXP-additionalLocator additionalLocator | XML | JSON |
| iso21090-ADXP-buildingNumberSuffix buildingNumberSuffix | XML | JSON |
| iso21090-ADXP-careOf careOf | XML | JSON |
| iso21090-ADXP-censusTract censusTract | XML | JSON |
| iso21090-ADXP-county county | XML | JSON |
| iso21090-ADXP-delimiter delimiter | XML | JSON |
| iso21090-ADXP-deliveryAddressLine deliveryAddressLine | XML | JSON |
| iso21090-ADXP-deliveryInstallationArea deliveryInstallationArea | XML | JSON |
| iso21090-ADXP-deliveryInstallationQualifier deliveryInstallationQualifier | XML | JSON |
| iso21090-ADXP-deliveryInstallationType deliveryInstallationType | XML | JSON |
| iso21090-ADXP-deliveryMode deliveryMode | XML | JSON |
| iso21090-ADXP-deliveryModeIdentifier deliveryModeIdentifier | XML | JSON |
| iso21090-ADXP-direction direction | XML | JSON |
| iso21090-ADXP-houseNumber houseNumber | XML | JSON |
| iso21090-ADXP-houseNumberNumeric houseNumberNumeric | XML | JSON |
| iso21090-ADXP-postBox postBox | XML | JSON |
| iso21090-ADXP-precinct precinct | XML | JSON |
| iso21090-ADXP-streetAddressLine streetAddressLine | XML | JSON |
| iso21090-ADXP-streetName streetName | XML | JSON |
| iso21090-ADXP-streetNameBase streetNameBase | XML | JSON |
| iso21090-ADXP-streetNameType streetNameType | XML | JSON |
| iso21090-ADXP-unitID unitID | XML | JSON |
| iso21090-ADXP-unitType unitType | XML | JSON |
| iso21090-EN-qualifier LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | XML | JSON |
| iso21090-SC-coding code for string | XML | JSON |
| iso21090-ST-language language | XML | JSON |
| iso21090-ST-translation translation | XML | JSON |
| iso21090-TEL-address RFC 3966 compliant telephone of fax number | XML | JSON |
| iso21090-nullFlavor NI | OTH | NINF | PINF | UNK | ASKU | NAV | NASK | TRC | MSK | NA | QS | XML | JSON |
| iso21090-preferred preferred | XML | JSON |
| iso21090-uncertainty Standard Deviation (same units as the quantity) | XML | JSON |
| iso21090-uncertaintyType Probability Distribution Type for uncertainty | XML | JSON |
| iso21090-verification verification | XML | JSON |
| ldl-chol-calculated LDL is Calculated | XML | JSON |
| location-alias Alias | XML | JSON |
| markup String equivalent with html markup | XML | JSON |
| maxDecimalPlaces Maximum digits after decimal | XML | JSON |
| maxSize Max size in MB | XML | JSON |
| maxValue Must be <= this value | XML | JSON |
| medicationdispense-validityPeriod Time interval for medication administration | XML | JSON |
| mimeType Type of attachment | XML | JSON |
| minLength At least this many characters | XML | JSON |
| minValue Must be >= this value | XML | JSON |
| observation-bodyPosition The body position during the observation | XML | JSON |
| observation-delta Qualitative change or trend in the measurement | XML | JSON |
| observation-laterality Side of the body site | XML | JSON |
| operationoutcome-issue-source Source of a validation message | XML | JSON |
| organization-alias Alias | XML | JSON |
| patient-adoptionInfo The adoption status of the patient | XML | JSON |
| patient-birthTime Time of day of birth | XML | JSON |
| patient-cadavericDonor Post-mortem donor status | XML | JSON |
| patient-citizenship Nation(s) where the patient claims citizenship | XML | JSON |
| patient-citizenship-code Nation code of citizenship | XML | JSON |
| patient-citizenship-period Time period of citizenship | XML | JSON |
| patient-clinicalTrial The patient's participation in clinical trials | XML | JSON |
| patient-clinicalTrial-NCT National Clinical Trial number | XML | JSON |
| patient-clinicalTrial-period The period of participation in the clinical trial | XML | JSON |
| patient-clinicalTrial-reason The reason for participation in the clinical trial | XML | JSON |
| patient-congregation A group of place of religious practice | XML | JSON |
| patient-disability Condition(s) limiting movement, senses, or activities | XML | JSON |
| patient-importance Special status given the patient | XML | JSON |
| patient-interpreterRequired Whether the patient needs an interpreter | XML | JSON |
| patient-militaryService Status of being former military | XML | JSON |
| patient-mothersMaidenName Mother's Maiden name | XML | JSON |
| patient-nationality Nationality | XML | JSON |
| patient-nationality-code Nationality Code | XML | JSON |
| patient-nationality-period Nationality Period | XML | JSON |
| pharmacy-core-approachBodySite Site used to introduce the medication | XML | JSON |
| pharmacy-core-doseType The type of dose, e.g., loading. | XML | JSON |
| pharmacy-core-infuseOver The length of the infusion | XML | JSON |
| pharmacy-core-maxDeliveryRate The maximum rate of substance administration | XML | JSON |
| pharmacy-core-maxDeliveryVolume The maximum amount of fluid to infuse | XML | JSON |
| pharmacy-core-minDosePerPeriod The minimum quantity of substance per period | XML | JSON |
| pharmacy-core-rateGoal The target rate for the infusion | XML | JSON |
| pharmacy-core-rateIncrement Change in dosing rate per interval | XML | JSON |
| pharmacy-core-rateIncrementInterval The period of time between rate increments | XML | JSON |
| pharmacy-core-refillsRemaining Number of refills allowed | XML | JSON |
| pharmacy-core-targetBodySite Site where the medication is delivered | XML | JSON |
| practitioner-classification Classification of the provider | XML | JSON |
| practitioner-primaryInd Indicator of primary specialty | XML | JSON |
| procedure-approachBodySite The access point or points used for this procedure | XML | JSON |
| procedure-incisionDateTime The first incision time | XML | JSON |
| procedure-method The method used to perform the procedure | XML | JSON |
| procedure-reasonNotPerformed Reason not performed | XML | JSON |
| procedurerequest-authorizedBy Authorizer of the request | XML | JSON |
| procedurerequest-method The method requested | XML | JSON |
| procedurerequest-reasonRefused Reason for refusal | XML | JSON |
| provenance Most recent change | XML | JSON |
| questionnaire-allowedResource Allowed resource for reference | XML | JSON |
| questionnaire-category What kind of questionnaire? | XML | JSON |
| questionnaire-deReference Implemented CDE | XML | JSON |
| questionnaire-defaultAsFixed Treat default as fixed value? | XML | JSON |
| questionnaire-defaultValue Initial presumed answer for question | XML | JSON |
| questionnaire-enableWhen Only allow data when: | XML | JSON |
| questionnaire-help Text to display if help incoked on group/question | XML | JSON |
| questionnaire-hidden Don't display to user | XML | JSON |
| questionnaire-instruction How to populate group or question | XML | JSON |
| questionnaire-label E.g. "1(a)", "2.5.3" | XML | JSON |
| questionnaire-maxLength No more than this many characters | XML | JSON |
| questionnaire-maxOccurs Maximum repetitions | XML | JSON |
| questionnaire-minOccurs Minimum repetitions | XML | JSON |
| questionnaire-security Security/privacy rules governing group/question | XML | JSON |
| questionnaire-tooltip Fly-over or equivalent text | XML | JSON |
| questionnaire-trailing Text to display after group/question content | XML | JSON |
| questionnaire-units Unit of measure for question | XML | JSON |
| referralrequest-reasonRefused Reason referral was refused | XML | JSON |
| regex Regular expression pattern | XML | JSON |
| relatedDeviceMetric Reference to the DeviceMetric resource | XML | JSON |
| specimen-collectionPriority Urgency for collection | XML | JSON |
| specimen-isDryWeight Whether quantity is a dry weight | XML | JSON |
| specimen-sequenceNumber The sequence number of the sample | XML | JSON |
| specimen-specialHandling Special handling of the specimen | XML | JSON |
| specimen-treatmentTime Time of treatment | XML | JSON |
| structuredefinition-display-hint Hinting information for the narrative generator | XML | JSON |
| structuredefinition-template-status Template Status Code (more authoring statuses) | XML | JSON |
| style Html style value | XML | JSON |
| styleSensitive Are styles important for processing? | XML | JSON |
| us-core-concernStatus The status of a Concern associated with a condition | XML | JSON |
| us-core-county Name of county | XML | JSON |
| us-core-direct Email is a "direct" email | XML | JSON |
| us-core-ethnicity A category of human sharing heritage | XML | JSON |
| us-core-race A category of humans sharing history, origin or nationality | XML | JSON |
| us-core-religion Patient's professed religious affiliation | XML | JSON |
| valueset-author User or Org actually involved in creating the value set content | XML | JSON |
| valueset-caseSensitive If code is case sensitive | XML | JSON |
| valueset-category Kind of value set | XML | JSON |
| valueset-comment Human-specified notes and other documentation | XML | JSON |
| valueset-comments Comment about the use of this code in this context | XML | JSON |
| valueset-conceptOrder Appearance order for user selection | XML | JSON |
| valueset-definition A definition for this code | XML | JSON |
| valueset-deprecated Whether the concept has been deprecated | XML | JSON |
| valueset-display Display value for the code | XML | JSON |
| valueset-effectiveDate When the value set version becomes Active and is available for use | XML | JSON |
| valueset-expirationDate When the value set version should no longer be used | XML | JSON |
| valueset-history What has happened over time | XML | JSON |
| valueset-keyWord Descriptors and key terms for search | XML | JSON |
| valueset-label E.g. "(a)", "1.", etc. | XML | JSON |
| valueset-oid OID assigned to the value set or code system | XML | JSON |
| valueset-ordinalValue Comparison value for ordinal codes | XML | JSON |
| valueset-otherName Alternative names | XML | JSON |
| valueset-reference Url of Value set the code was chosen from | XML | JSON |
| valueset-sourceReference Where did this content come from | XML | JSON |
| valueset-subsumes Codes that this concept subsumes that have already been declared elsewhere | XML | JSON |
| valueset-systemName Code system name | XML | JSON |
| valueset-systemRef Where to find code system | XML | JSON |
| valueset-trusted-expansion Reference to a trusted expansion | XML | JSON |
| valueset-usage Who has used and how? | XML | JSON |
| valueset-workflowStatus Indicates the state of development of the value set | XML | JSON |
| imagingstudy-radiationDose The amount of radiation, as a range | XML | JSON |
| imagingstudy-radiationDuration The length of time for radiation exposure | XML | JSON |
| immunization-protocol What protocol was followed | XML | JSON |
| immunization-reaction Details of a reaction that follows immunization | XML | JSON |
| immunization-reported True if this administration was reported | XML | JSON |
| indirectTarget target if different from the subject. | XML | JSON |
| iso21090-AD-use BAD | CONF | HP | HV | DIR | PUB | PHYS | PST | XML | JSON |
| iso21090-ADXP-additionalLocator additionalLocator | XML | JSON |
| iso21090-ADXP-buildingNumberSuffix buildingNumberSuffix | XML | JSON |
| iso21090-ADXP-careOf careOf | XML | JSON |
| iso21090-ADXP-censusTract censusTract | XML | JSON |
| iso21090-ADXP-county county | XML | JSON |
| iso21090-ADXP-delimiter delimiter | XML | JSON |
| iso21090-ADXP-deliveryAddressLine deliveryAddressLine | XML | JSON |
| iso21090-ADXP-deliveryInstallationArea deliveryInstallationArea | XML | JSON |
| iso21090-ADXP-deliveryInstallationQualifier deliveryInstallationQualifier | XML | JSON |
| iso21090-ADXP-deliveryInstallationType deliveryInstallationType | XML | JSON |
| iso21090-ADXP-deliveryMode deliveryMode | XML | JSON |
| iso21090-ADXP-deliveryModeIdentifier deliveryModeIdentifier | XML | JSON |
| iso21090-ADXP-direction direction | XML | JSON |
| iso21090-ADXP-houseNumber houseNumber | XML | JSON |
| iso21090-ADXP-houseNumberNumeric houseNumberNumeric | XML | JSON |
| iso21090-ADXP-postBox postBox | XML | JSON |
| iso21090-ADXP-precinct precinct | XML | JSON |
| iso21090-ADXP-streetAddressLine streetAddressLine | XML | JSON |
| iso21090-ADXP-streetName streetName | XML | JSON |
| iso21090-ADXP-streetNameBase streetNameBase | XML | JSON |
| iso21090-ADXP-streetNameType streetNameType | XML | JSON |
| iso21090-ADXP-unitID unitID | XML | JSON |
| iso21090-ADXP-unitType unitType | XML | JSON |
| iso21090-EN-qualifier LS | AC | NB | PR | HON | BR | AD | SP | MID | CL | IN | XML | JSON |
| iso21090-SC-coding code for string | XML | JSON |
| iso21090-ST-language language | XML | JSON |
| iso21090-ST-translation translation | XML | JSON |
| iso21090-TEL-address RFC 3966 compliant telephone of fax number | XML | JSON |
| iso21090-nullFlavor NI | OTH | NINF | PINF | UNK | ASKU | NAV | NASK | TRC | MSK | NA | QS | XML | JSON |
| iso21090-preferred preferred | XML | JSON |
| iso21090-uncertainty Standard Deviation (same units as the quantity) | XML | JSON |
| iso21090-uncertaintyType Probability Distribution Type for uncertainty | XML | JSON |
| iso21090-verification verification | XML | JSON |
| ldl-chol-calculated LDL is Calculated | XML | JSON |
| location-alias Alias | XML | JSON |
| markup String equivalent with html markup | XML | JSON |
| maxDecimalPlaces Maximum digits after decimal | XML | JSON |
| maxSize Max size in MB | XML | JSON |
| maxValue Must be <= this value | XML | JSON |
| medicationdispense-validityPeriod Time interval for medication administration | XML | JSON |
| mimeType Type of attachment | XML | JSON |
| minLength At least this many characters | XML | JSON |
| minValue Must be >= this value | XML | JSON |
| observation-bodyPosition The body position during the observation | XML | JSON |
| observation-delta Qualitative change or trend in the measurement | XML | JSON |
| observation-laterality Side of the body site | XML | JSON |
| operationoutcome-issue-source Source of a validation message | XML | JSON |
| organization-alias Alias | XML | JSON |
| patient-adoptionInfo The adoption status of the patient | XML | JSON |
| patient-birthTime Time of day of birth | XML | JSON |
| patient-cadavericDonor Post-mortem donor status | XML | JSON |
| patient-citizenship Nation(s) where the patient claims citizenship | XML | JSON |
| patient-citizenship-code Nation code of citizenship | XML | JSON |
| patient-citizenship-period Time period of citizenship | XML | JSON |
| patient-clinicalTrial The patient's participation in clinical trials | XML | JSON |
| patient-clinicalTrial-NCT National Clinical Trial number | XML | JSON |
| patient-clinicalTrial-period The period of participation in the clinical trial | XML | JSON |
| patient-clinicalTrial-reason The reason for participation in the clinical trial | XML | JSON |
| patient-congregation A group of place of religious practice | XML | JSON |
| patient-disability Condition(s) limiting movement, senses, or activities | XML | JSON |
| patient-importance Special status given the patient | XML | JSON |
| patient-interpreterRequired Whether the patient needs an interpreter | XML | JSON |
| patient-militaryService Status of being former military | XML | JSON |
| patient-mothersMaidenName Mother's Maiden name | XML | JSON |
| patient-nationality Nationality | XML | JSON |
| patient-nationality-code Nationality Code | XML | JSON |
| patient-nationality-period Nationality Period | XML | JSON |
| pharmacy-core-approachBodySite Site used to introduce the medication | XML | JSON |
| pharmacy-core-doseType The type of dose, e.g., loading. | XML | JSON |
| pharmacy-core-infuseOver The length of the infusion | XML | JSON |
| pharmacy-core-maxDeliveryRate The maximum rate of substance administration | XML | JSON |
| pharmacy-core-maxDeliveryVolume The maximum amount of fluid to infuse | XML | JSON |
| pharmacy-core-minDosePerPeriod The minimum quantity of substance per period | XML | JSON |
| pharmacy-core-rateGoal The target rate for the infusion | XML | JSON |
| pharmacy-core-rateIncrement Change in dosing rate per interval | XML | JSON |
| pharmacy-core-rateIncrementInterval The period of time between rate increments | XML | JSON |
| pharmacy-core-refillsRemaining Number of refills allowed | XML | JSON |
| pharmacy-core-targetBodySite Site where the medication is delivered | XML | JSON |
| practitioner-classification Classification of the provider | XML | JSON |
| practitioner-primaryInd Indicator of primary specialty | XML | JSON |
| procedure-approachBodySite The access point or points used for this procedure | XML | JSON |
| procedure-incisionDateTime The first incision time | XML | JSON |
| procedure-method The method used to perform the procedure | XML | JSON |
| procedure-reasonNotPerformed Reason not performed | XML | JSON |
| procedurerequest-authorizedBy Authorizer of the request | XML | JSON |
| procedurerequest-method The method requested | XML | JSON |
| procedurerequest-reasonRefused Reason for refusal | XML | JSON |
| provenance Most recent change | XML | JSON |
| questionnaire-allowedResource Allowed resource for reference | XML | JSON |
| questionnaire-category What kind of questionnaire? | XML | JSON |
| questionnaire-deReference Implemented CDE | XML | JSON |
| questionnaire-defaultAsFixed Treat default as fixed value? | XML | JSON |
| questionnaire-defaultValue Initial presumed answer for question | XML | JSON |
| questionnaire-enableWhen Only allow data when: | XML | JSON |
| questionnaire-help Text to display if help incoked on group/question | XML | JSON |
| questionnaire-hidden Don't display to user | XML | JSON |
| questionnaire-instruction How to populate group or question | XML | JSON |
| questionnaire-label E.g. "1(a)", "2.5.3" | XML | JSON |
| questionnaire-maxLength No more than this many characters | XML | JSON |
| questionnaire-maxOccurs Maximum repetitions | XML | JSON |
| questionnaire-minOccurs Minimum repetitions | XML | JSON |
| questionnaire-security Security/privacy rules governing group/question | XML | JSON |
| questionnaire-tooltip Fly-over or equivalent text | XML | JSON |
| questionnaire-trailing Text to display after group/question content | XML | JSON |
| questionnaire-units Unit of measure for question | XML | JSON |
| referralrequest-reasonRefused Reason referral was refused | XML | JSON |
| regex Regular expression pattern | XML | JSON |
| relatedDeviceMetric Reference to the DeviceMetric resource | XML | JSON |
| specimen-collectionPriority Urgency for collection | XML | JSON |
| specimen-isDryWeight Whether quantity is a dry weight | XML | JSON |
| specimen-sequenceNumber The sequence number of the sample | XML | JSON |
| specimen-specialHandling Special handling of the specimen | XML | JSON |
| specimen-treatmentTime Time of treatment | XML | JSON |
| structuredefinition-display-hint Hinting information for the narrative generator | XML | JSON |
| structuredefinition-template-status Template Status Code (more authoring statuses) | XML | JSON |
| style Html style value | XML | JSON |
| styleSensitive Are styles important for processing? | XML | JSON |
| us-core-concernStatus The status of a Concern associated with a condition | XML | JSON |
| us-core-county Name of county | XML | JSON |
| us-core-direct Email is a "direct" email | XML | JSON |
| us-core-ethnicity A category of human sharing heritage | XML | JSON |
| us-core-race A category of humans sharing history, origin or nationality | XML | JSON |
| us-core-religion Patient's professed religious affiliation | XML | JSON |
| valueset-author User or Org actually involved in creating the value set content | XML | JSON |
| valueset-caseSensitive If code is case sensitive | XML | JSON |
| valueset-category Kind of value set | XML | JSON |
| valueset-comment Human-specified notes and other documentation | XML | JSON |
| valueset-comments Comment about the use of this code in this context | XML | JSON |
| valueset-conceptOrder Appearance order for user selection | XML | JSON |
| valueset-definition A definition for this code | XML | JSON |
| valueset-deprecated Whether the concept has been deprecated | XML | JSON |
| valueset-display Display value for the code | XML | JSON |
| valueset-effectiveDate When the value set version becomes Active and is available for use | XML | JSON |
| valueset-expirationDate When the value set version should no longer be used | XML | JSON |
| valueset-history What has happened over time | XML | JSON |
| valueset-keyWord Descriptors and key terms for search | XML | JSON |
| valueset-label E.g. "(a)", "1.", etc. | XML | JSON |
| valueset-oid OID assigned to the value set or code system | XML | JSON |
| valueset-ordinalValue Comparison value for ordinal codes | XML | JSON |
| valueset-otherName Alternative names | XML | JSON |
| valueset-reference Url of Value set the code was chosen from | XML | JSON |
| valueset-sourceReference Where did this content come from | XML | JSON |
| valueset-subsumes Codes that this concept subsumes that have already been declared elsewhere | XML | JSON |
| valueset-systemName Code system name | XML | JSON |
| valueset-systemRef Where to find code system | XML | JSON |
| valueset-trusted-expansion Reference to a trusted expansion | XML | JSON |
| valueset-usage Who has used and how? | XML | JSON |
| valueset-workflowStatus Indicates the state of development of the value set | XML | JSON |
| openEHR Profiles | ||
| openEHR-administration Actual medication record, if known | XML | JSON |
| openEHR-careplan Clinical Management Details | XML | JSON |
| openEHR-exposureDate Date(/time) of first exposure to Substance | XML | JSON |
| openEHR-exposureDescription Text description about exposure to the Substance | XML | JSON |
| openEHR-exposureDuration Amount of time individual was exposed to Substance | XML | JSON |
| openEHR-location Body site of manifestations | XML | JSON |
| openEHR-management Clinical Management Description | XML | JSON |
| openEHR-test Observations that confirm or refute | XML | JSON |
| openEHR-administration Actual medication record, if known | XML | JSON |
| openEHR-careplan Clinical Management Details | XML | JSON |
| openEHR-exposureDate Date(/time) of first exposure to Substance | XML | JSON |
| openEHR-exposureDescription Text description about exposure to the Substance | XML | JSON |
| openEHR-exposureDuration Amount of time individual was exposed to Substance | XML | JSON |
| openEHR-location Body site of manifestations | XML | JSON |
| openEHR-management Clinical Management Description | XML | JSON |
| openEHR-test Observations that confirm or refute | XML | JSON |
| EHRS Functional model - Record Lifecycle Events | ||
| auditevent-ehrs-rle-location Where the activity occurred, if relevant | XML | JSON |
| auditevent-ehrs-rle-policy Policy or plan th eactivity was defined by | XML | JSON |
| auditevent-ehrs-rle-reason Reason activity is occurring | XML | JSON |
| auditevent-ehrs-rle-location Where the activity occurred, if relevant | XML | JSON |
| auditevent-ehrs-rle-policy Policy or plan th eactivity was defined by | XML | JSON |
| auditevent-ehrs-rle-reason Reason activity is occurring | XML | JSON |
| US Lab Profile | ||
| uslabcc-practitioner Copy to practitioner | XML | JSON |
| uslabobservationkind Kind of observation | XML | JSON |
| uslabspecimenrejectreason Specimen Rejection Reason | XML | JSON |
| uslabcc-practitioner Copy to practitioner | XML | JSON |
| uslabobservationkind Kind of observation | XML | JSON |
| uslabspecimenrejectreason Specimen Rejection Reason | XML | JSON |
| Quality Improvement Core | ||
| adverseevent-qicore-cause The possible cause(s) of the adverse event | XML | JSON |
| adverseevent-qicore-cause-certainty certainty | XML | JSON |
| adverseevent-qicore-cause-item Associated clinical action or substance | XML | JSON |
| adverseevent-qicore-clinicalStudy Related clinical study | XML | JSON |
| adverseevent-qicore-code Primary code | XML | JSON |
| adverseevent-qicore-didNotOccur Indicates if the adverse event was absent | XML | JSON |
| adverseevent-qicore-period Effective time period | XML | JSON |
| adverseevent-qicore-severity severity | XML | JSON |
| adverseevent-qicore-cause The possible cause(s) of the adverse event | XML | JSON |
| adverseevent-qicore-cause-certainty certainty | XML | JSON |
| adverseevent-qicore-cause-item Associated clinical action or substance | XML | JSON |
| adverseevent-qicore-clinicalStudy Related clinical study | XML | JSON |
| adverseevent-qicore-code Primary code | XML | JSON |
| adverseevent-qicore-didNotOccur Indicates if the adverse event was absent | XML | JSON |
| adverseevent-qicore-period Effective time period | XML | JSON |
| adverseevent-qicore-severity severity | XML | JSON |
| medication-isActiveIngredient Active ingredient indicator | XML | JSON |
| medication-usualRoute Typical application route | XML | JSON |
| medication-isActiveIngredient Active ingredient indicator | XML | JSON |
| medication-usualRoute Typical application route | XML | JSON |
| Structured Data Capture Project | ||
| 11179-de-effective-period When data element is "valid" | XML | JSON |
| 11179-de-is-data-element-concept Is code the DEC for the data element? | XML | JSON |
| 11179-de-effective-period When data element is "valid" | XML | JSON |
| 11179-de-is-data-element-concept Is code the DEC for the data element? | XML | JSON |
| questionnaire-sdc-endpoint Where to send answers | XML | JSON |
| questionnaire-sdc-optionalDisplay Can suppress from display to user | XML | JSON |
| questionnaire-sdc-specialGroup header | footer | XML | JSON |
| questionnaire-sdc-endpoint Where to send answers | XML | JSON |
| questionnaire-sdc-optionalDisplay Can suppress from display to user | XML | JSON |
| questionnaire-sdc-specialGroup header | footer | XML | JSON |
| Clinical Quality Measure Framework | ||
| cqm-BasedOnMeasure Based On Measure | XML | JSON |
| cqm-BasedOnMeasure Based On Measure | XML | JSON |
| Healthcare Services Platform Consortium | ||
| hspc-DeltaFlag Indicate the data value in the containing model is a change from a previous instance of the same model | XML | JSON |
| hspc-ReportingPriority Urgency Level for result | XML | JSON |
| hspc-Updated When this information was last updated | XML | JSON |
| hspc-Verified Whether the information has been verified with the source | XML | JSON |
| hspc-DeltaFlag Indicate the data value in the containing model is a change from a previous instance of the same model | XML | JSON |
| hspc-ReportingPriority Urgency Level for result | XML | JSON |
| hspc-Updated When this information was last updated | XML | JSON |
| hspc-Verified Whether the information has been verified with the source | XML | JSON |
| provenance-hspc-attribution-actionMethod Action Method | XML | JSON |
| provenance-hspc-attribution-attributionCode Attribution Code | XML | JSON |
| provenance-hspc-attribution-individualPerson Individual Person | XML | JSON |
| provenance-hspc-attribution-patientLocation Patient Location | XML | JSON |
| provenance-hspc-attribution-providerLocation Provider Location | XML | JSON |
| provenance-hspc-attribution-actionMethod Action Method | XML | JSON |
| provenance-hspc-attribution-attributionCode Attribution Code | XML | JSON |
| provenance-hspc-attribution-individualPerson Individual Person | XML | JSON |
| provenance-hspc-attribution-patientLocation Patient Location | XML | JSON |
| provenance-hspc-attribution-providerLocation Provider Location | XML | JSON |
XML
Example of structuredefinition (id = "example")
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="example"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/example"/> <name value="Example Lipid Profile"/> <publisher value="Grahame Grieve"/> <contact> <telecom> <system value="url"/> <value value="grahame@healthintersections.com.au"/> </telecom> </contact> <description value="Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes"/> <status value="draft"/> <date value="2012-05-12"/> <type value="constraint"/> <abstract value="false"/> <snapshot> <element> <path value="DiagnosticReport"/> <name value="LipidProfile"/> <short value="Lipid Lab Report"/> <definition value="The findings and interpretation of a general lipd lab profile."/> <comments value="In this profile, mustSupport means that authoring systems must include the ability to report these elements, and processing systems must cater for them by either displaying them to the user or considering them appropriately in decision support systems."/> <min value="1"/> <max value="1"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.extension"/> <slicing> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.status"/> <short value="registered|interim|final|amended|cancelled|withdrawn"/> <definition value="The status of the diagnostic report as a whole."/> <comments value="This is labeled as "Is Modifier" because applications need to take appropriate action if a report is withdrawn."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <isModifier value="false"/> <binding> <name value="ObservationStatus"/> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/observation-status"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.issued"/> <short value="Date this version was released"/> <definition value="The date and/or time that this version of the report was released from the source diagnostic service."/> <comments value="May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.subject"/> <short value="The subject of the report"/> <definition value="The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources."/> <min value="1"/> <max value="1"/> <type> <code value="Reference(Patient|Group|Device)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.performer"/> <short value="Responsible Diagnostic Service"/> <definition value="The diagnostic service that is responsible for issuing the report."/> <comments value="This is not necessarily the source of the atomic data items - it's the entity that takes responsibility for the clinical report."/> <min value="1"/> <max value="1"/> <type> <code value="Reference(Organization)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.reportId"/> <short value="Id for external references to this report"/> <definition value="The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail"/> <short value="What was requested"/> <definition value="Details concerning a single pathology test requested."/> <comments value="Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single Pathology test result resource. Note that there are also cases where one request leads to multiple reports."/> <min value="0"/> <max value="*"/> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail.encounter"/> <short value="Context where request was made"/> <definition value="The encounter that this diagnostic investigation is associated with."/> <min value="0"/> <max value="1"/> <type> <code value="Reference(Encounter)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail.requestOrderId"/> <short value="Id assigned by requester"/> <definition value="The local ID assigned to the order by the order requester."/> <comments value="Equivalent to the Placer Order Identifier."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail.receiverOrderId"/> <short value="Receiver's Id for the request"/> <definition value="The local ID assigned to the test order by the diagnostic service provider."/> <comments value="Usually equivalent to the DICOM Accession Number and the Filler Order Identifier."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail.requestTest"/> <short value="Test Requested"/> <definition value="Identification of pathology test requested,."/> <comments value="Useful where the test requested differs from the test actually performed."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticRequests"/> <strength value="example"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/diagnostic-requests"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.requestDetail.bodySite"/> <short value="Location of requested test (if applicable)"/> <definition value="Anatomical location where the request test should be performed."/> <comments value="This is often implicit or explicit in the requested test, and doesn't need to be specified if so."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="BodySite"/> <strength value="example"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/body-site"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.requestDetail.requester"/> <short value="Responsible for request"/> <definition value="Details of the clinician or organization requesting the diagnostic service."/> <min value="0"/> <max value="1"/> <type> <code value="Reference(Organization|Practitioner)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.requestDetail.clinicalInfo"/> <short value="Clinical information provided"/> <definition value="Details of the clinical information provided to the diagnostic service along with the original request."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.serviceCategory"/> <short value="Biochemistry, Haematology etc."/> <definition value="The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticServiceSection"/> <strength value="preferred"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/diagnostic-service-sections"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.diagnostic[x]"/> <short value="Diagnostically relevant time of diagnostic report"/> <definition value="The diagnostically relevant time for this report - that is, the point in time at which the observations that are reported in this diagnostic report relate to the patient."/> <comments value="If the diagnostic procedure was performed on the patient, this is the time it was performed. If there is specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic."/> <min value="1"/> <max value="1"/> <type> <code value="dateTime"/> </type> <type> <code value="Period"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results"/> <short value="Lipid Lab Results"/> <definition value="Lipid Lab Results."/> <min value="1"/> <max value="1"/> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.name"/> <short value="LOINC Code for Lipid Panel with LDL"/> <definition value="LOINC Code for Lipid Panel with LDL."/> <comments value="LOINC code includes "direct" LDL - does this mean LDL derived by measuring VLDL by ultracentrifugation? This panel includes both measured and calculated LDL."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosticResultGroupNames"/> <strength value="preferred"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/report-names"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.results.specimen"/> <short value="Specimen details for this group"/> <definition value="Details about the individual specimen to which these 'Result group' test results refer."/> <min value="0"/> <max value="1"/> <type> <code value="Reference(Specimen)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.group"/> <short value="No subgroups allowed"/> <definition value="No subgroups allowed."/> <comments value="Nested report groups beyond the first level are not used often, but arise in structured pathology reports, and where there is more than one sensitivity assessment per discovered organism."/> <min value="0"/> <max value="0"/> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.result"/> <name value="Cholesterol"/> <slicing> <discriminator value="name"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Cholesterol Result"/> <definition value="Reference to Cholesterol Result."/> <min value="1"/> <max value="1"/> <type> <code value="Reference(Observation)"/> <profile value="#Cholesterol"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.result"/> <name value="Triglyceride"/> <short value="Triglyceride Result"/> <definition value="Group of elements for Triglyceride result."/> <min value="1"/> <max value="1"/> <type> <code value="Reference(Observation)"/> <profile value="#Triglyceride"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.result"/> <name value="HDL Cholesterol"/> <short value="HDL Cholesterol Result"/> <definition value="Group of elements for HDL Cholesterol result."/> <min value="1"/> <max value="1"/> <type> <code value="Reference(Observation)"/> <profile value="#HDLCholesterol"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.results.result"/> <name value="LDL Cholesterol"/> <short value="LDL Cholesterol result, if reported"/> <definition value="LDL Cholesterol result, if reported."/> <min value="0"/> <max value="1"/> <type> <code value="Reference(Observation)"/> <profile value="#LDLCholesterol"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.image"/> <short value="Key images associated with this report"/> <definition value="A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest)."/> <comments value="An imaging study is a list of images following a DICOM specification - only list one of these, or multiple images."/> <min value="0"/> <max value="*"/> <type> <code value="Reference(Media|ImagingStudy)"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.conclusion"/> <short value="Clinical Interpretation of Lipid Panel"/> <definition value="May include diagnosis or suggestions for follow up testing."/> <comments value="It's not unusual for the lab to make some kind of interpretative comment on the set of results."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isModifier value="false"/> </element> <element> <path value="DiagnosticReport.codedDiagnosis"/> <short value="No codes for a lipid panel"/> <definition value="No codes for a lipid panel."/> <comments value="Not used in this context."/> <min value="0"/> <max value="0"/> <type> <code value="CodeableConcept"/> </type> <isModifier value="false"/> <binding> <name value="DiagnosisCodes"/> <strength value="example"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/clinical-findings"/> </valueSetReference> </binding> </element> <element> <path value="DiagnosticReport.representation"/> <short value="Entire Report as issued"/> <definition value="Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent."/> <comments value="Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf, application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocum ent.wordprocessingml.document. Application/pdf is recommended as the most reliable and interoperable in this context."/> <min value="0"/> <max value="*"/> <type> <code value="Attachment"/> </type> <isModifier value="false"/> </element> </snapshot> </StructureDefinition>
JSON
Example of structuredefinition
{
"resourceType": "StructureDefinition",
"id": "example",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/example",
"name": "Example Lipid Profile",
"publisher": "Grahame Grieve",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "grahame@healthintersections.com.au"
}
]
}
],
"description": "Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes",
"status": "draft",
"date": "2012-05-12",
"type": "constraint",
"abstract": false,
"snapshot": {
"element": [
{
"path": "DiagnosticReport",
"name": "LipidProfile",
"short": "Lipid Lab Report",
"definition": "The findings and interpretation of a general lipd lab profile.",
"comments": "In this profile, mustSupport means that authoring systems must include the ability to report these elements, and processing systems must cater for them by either displaying them to the user or considering them appropriately in decision support systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.status",
"short": "registered|interim|final|amended|cancelled|withdrawn",
"definition": "The status of the diagnostic report as a whole.",
"comments": "This is labeled as \"Is Modifier\" because applications need to take appropriate action if a report is withdrawn.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "ObservationStatus",
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/observation-status"
}
}
},
{
"path": "DiagnosticReport.issued",
"short": "Date this version was released",
"definition": "The date and/or time that this version of the report was released from the source diagnostic service.",
"comments": "May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.subject",
"short": "The subject of the report",
"definition": "The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference(Patient|Group|Device)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.performer",
"short": "Responsible Diagnostic Service",
"definition": "The diagnostic service that is responsible for issuing the report.",
"comments": "This is not necessarily the source of the atomic data items - it's the entity that takes responsibility for the clinical report.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference(Organization)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.reportId",
"short": "Id for external references to this report",
"definition": "The local ID assigned to the report by the order filler, usually by the Information System of the diagnostic service provider.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail",
"short": "What was requested",
"definition": "Details concerning a single pathology test requested.",
"comments": "Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single Pathology test result resource. Note that there are also cases where one request leads to multiple reports.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail.encounter",
"short": "Context where request was made",
"definition": "The encounter that this diagnostic investigation is associated with.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference(Encounter)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail.requestOrderId",
"short": "Id assigned by requester",
"definition": "The local ID assigned to the order by the order requester.",
"comments": "Equivalent to the Placer Order Identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail.receiverOrderId",
"short": "Receiver's Id for the request",
"definition": "The local ID assigned to the test order by the diagnostic service provider.",
"comments": "Usually equivalent to the DICOM Accession Number and the Filler Order Identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail.requestTest",
"short": "Test Requested",
"definition": "Identification of pathology test requested,.",
"comments": "Useful where the test requested differs from the test actually performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticRequests",
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-requests"
}
}
},
{
"path": "DiagnosticReport.requestDetail.bodySite",
"short": "Location of requested test (if applicable)",
"definition": "Anatomical location where the request test should be performed.",
"comments": "This is often implicit or explicit in the requested test, and doesn't need to be specified if so.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "BodySite",
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/body-site"
}
}
},
{
"path": "DiagnosticReport.requestDetail.requester",
"short": "Responsible for request",
"definition": "Details of the clinician or organization requesting the diagnostic service.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference(Organization|Practitioner)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.requestDetail.clinicalInfo",
"short": "Clinical information provided",
"definition": "Details of the clinical information provided to the diagnostic service along with the original request.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.serviceCategory",
"short": "Biochemistry, Haematology etc.",
"definition": "The section of the diagnostic service that performs the examination e.g. biochemistry, haematology, MRI.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticServiceSection",
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/diagnostic-service-sections"
}
}
},
{
"path": "DiagnosticReport.diagnostic[x]",
"short": "Diagnostically relevant time of diagnostic report",
"definition": "The diagnostically relevant time for this report - that is, the point in time at which the observations that are reported in this diagnostic report relate to the patient.",
"comments": "If the diagnostic procedure was performed on the patient, this is the time it was performed. If there is specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.results",
"short": "Lipid Lab Results",
"definition": "Lipid Lab Results.",
"min": 1,
"max": "1",
"isModifier": false
},
{
"path": "DiagnosticReport.results.name",
"short": "LOINC Code for Lipid Panel with LDL",
"definition": "LOINC Code for Lipid Panel with LDL.",
"comments": "LOINC code includes \"direct\" LDL - does this mean LDL derived by measuring VLDL by ultracentrifugation? This panel includes both measured and calculated LDL.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosticResultGroupNames",
"strength": "preferred",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/report-names"
}
}
},
{
"path": "DiagnosticReport.results.specimen",
"short": "Specimen details for this group",
"definition": "Details about the individual specimen to which these 'Result group' test results refer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference(Specimen)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.results.group",
"short": "No subgroups allowed",
"definition": "No subgroups allowed.",
"comments": "Nested report groups beyond the first level are not used often, but arise in structured pathology reports, and where there is more than one sensitivity assessment per discovered organism.",
"min": 0,
"max": "0",
"isModifier": false
},
{
"path": "DiagnosticReport.results.result",
"name": "Cholesterol",
"slicing": {
"discriminator": [
"name"
],
"ordered": false,
"rules": "open"
},
"short": "Cholesterol Result",
"definition": "Reference to Cholesterol Result.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference(Observation)",
"profile": "#Cholesterol"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.results.result",
"name": "Triglyceride",
"short": "Triglyceride Result",
"definition": "Group of elements for Triglyceride result.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference(Observation)",
"profile": "#Triglyceride"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.results.result",
"name": "HDL Cholesterol",
"short": "HDL Cholesterol Result",
"definition": "Group of elements for HDL Cholesterol result.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference(Observation)",
"profile": "#HDLCholesterol"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.results.result",
"name": "LDL Cholesterol",
"short": "LDL Cholesterol result, if reported",
"definition": "LDL Cholesterol result, if reported.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference(Observation)",
"profile": "#LDLCholesterol"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.image",
"short": "Key images associated with this report",
"definition": "A list of key images associated with this report. The images are generally created during the diagnostic process, and maybe directly of the patient, or of treated specimens (i.e. slides of interest).",
"comments": "An imaging study is a list of images following a DICOM specification - only list one of these, or multiple images.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference(Media|ImagingStudy)"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.conclusion",
"short": "Clinical Interpretation of Lipid Panel",
"definition": "May include diagnosis or suggestions for follow up testing.",
"comments": "It's not unusual for the lab to make some kind of interpretative comment on the set of results.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
},
{
"path": "DiagnosticReport.codedDiagnosis",
"short": "No codes for a lipid panel",
"definition": "No codes for a lipid panel.",
"comments": "Not used in this context.",
"min": 0,
"max": "0",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "DiagnosisCodes",
"strength": "example",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/clinical-findings"
}
}
},
{
"path": "DiagnosticReport.representation",
"short": "Entire Report as issued",
"definition": "Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.",
"comments": "Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf, application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.wordprocessingml.document. Application/pdf is recommended as the most reliable and interoperable in this context.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.