2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

6.20.7 Resource ExtensionDefinition - Examples

Example Index:

Example Extension DefinitionXMLJSON
General Language Translation ExtensionXMLJSON

Extensions Defined as part of the specification:

11179-effective-periodWhen data element is "valid"XMLJSON
11179-objectClassObject ClassXMLJSON
11179-permitted-value-conceptmapMapping from permitted to transmittedXMLJSON
11179-permitted-value-valuesetPermitted valuesXMLJSON
11179-propertyObject Class PropertyXMLJSON
AdditionalInterpretationCodesAdditional Interpretation CodesXMLJSON
CCDAObsRelatedTypesCCDA related observation typesXMLJSON
ListStatusregistered | preliminary | finalXMLJSON
ObservationNegationIndicatorObservation Negation IndicatorXMLJSON
ProfilegeneticsAlleleNameCommon nameXMLJSON
ProfilegeneticsAllelicStateVariant allelic stateXMLJSON
ProfilegeneticsAminoAcidChangeProtein variant following HGVS nomenclature and identifiers.XMLJSON
ProfilegeneticsAminoAcidChangeTypeType of protien variation expressed using Sequence Ontology or LOINC codes.XMLJSON
ProfilegeneticsChromosomeThe chromosome containing the variant.XMLJSON
ProfilegeneticsDNARegionNameExonic location of variant.XMLJSON
ProfilegeneticsDNASequenceVariationIdentifiercDNA variant following HGVS nomenclature and identifiers.XMLJSON
ProfilegeneticsDNASequenceVariationTypeType of variation expressed using Sequence Ontology or LOINC codes.XMLJSON
ProfilegeneticsGeneIdentifierHGNC gene symbol and identifier.XMLJSON
ProfilegeneticsGenomeBuildThe Genome Build used for reference, with version number if used.XMLJSON
ProfilegeneticsGenomicReferenceSequenceIdentifierThe genomic reference sequence identifier.XMLJSON
ProfilegeneticsGenomicSourceClassGenomic source of the variantXMLJSON
ProfilegeneticsGenomicStartNucleotide location startXMLJSON
ProfilegeneticsGenomicStopNucleotide location endXMLJSON
ProfilegeneticsObservedAlleleOserved nucleotides at genomic location. Use '-' for delections.XMLJSON
ProfilegeneticsProteinReferenceSequenceIndentifierReference identifier for protein transcript, with version.XMLJSON
ProfilegeneticsReferenceAlleleNucleotides at location on reference sequence. Use '-' for insertions.XMLJSON
ProfilegeneticsTranscriptReferenceSequenseIdentifierReference identifier for cDNA transcript, with version.XMLJSON
additionalattachementvalueAdditional attachment resultsXMLJSON
additionalcodedvalueAdditional coded resultsXMLJSON
additionaldatetimevalueAdditional datetime resultsXMLJSON
additionalnumericvalueAdditional quantitative resultsXMLJSON
additionalobservationidAdditional identifierXMLJSON
additionalperiodvalueAdditional time period resultsXMLJSON
additionalratiovalueAdditional ratio resultsXMLJSON
additionaltimevalueAdditional time resultsXMLJSON
birthPlacePlace of Birth for patientXMLJSON
cda-birthplaceCDA BirthplaceXMLJSON
cda-guardian-idCDA Guardian IdentifierXMLJSON
cda-inFulFillmentOfCDA In Fulfillment ofXMLJSON
cda-language-modeCDA Language ModeXMLJSON
cda-language-preferenceCDA Language PreferenceXMLJSON
cda-language-proficiencyCDA Language ProficiencyXMLJSON
cda-org-partof-codeCDA Organization Relationship TypeXMLJSON
cda-org-partof-effectivetimeCDA Organization Relationship Effective timeXMLJSON
cda-org-partof-statuscodeCDA Organization Relationship StatusXMLJSON
cda-whole-organizationCDA Organizational ParentXMLJSON
conformance-common-expectationSHALL | SHOULD | MAY |SHOULD-NOTXMLJSON
conformance-common-prohibitedFunctionality not allowedXMLJSON
cqm-BasedOnMeasureBased On MeasureXMLJSON
data-absent-reasonunknown | asked | temp | notasked | masked | unsupported | astext | errorXMLJSON
datadictionaryAssociates the profile with a collection of Data ElementsXMLJSON
entryFormatUser prompt for formatXMLJSON
genetics-relationObservationGenetic markers, ethnicity, etc.XMLJSON
genetics-relationParentMother(s) & Father(s) - genetic & otherXMLJSON
goal-common-categoryGoal categoryXMLJSON
goal-common-goalAssociated goalXMLJSON
goal-common-targetTarget for GoalXMLJSON
hspc-DeltaFlagIndicate the data value in the containing model is a change from a previous instance of the same modelXMLJSON
hspc-ReportingPriorityUrgency Level for resultXMLJSON
hspc-UpdatedWhen this information was last updatedXMLJSON
hspc-VerifiedWhether the information has been verified with the sourceXMLJSON
hspc-core-observation-associatedOrderAssociated OrderXMLJSON
hspc-core-observation-associatedPreconditionAssociated PreconditionXMLJSON
hspc-core-observation-bodyPositionBody PositionXMLJSON
hspc-core-observation-deltaDeltaXMLJSON
hspc-core-observation-validationMethodValidation MethodXMLJSON
hspc-practitioner-communicationModeCommunication ModeXMLJSON
hspc-practitioner-primaryIndPrimary IndicatorXMLJSON
hspc-specimen-isDryWeightIs Dry WeightXMLJSON
hspc-specimen-isVolumeFuzzyIs Volume FuzzyXMLJSON
hspc-specimen-marginsTumorInvolvementMargins Tumor InvolvementXMLJSON
identifierExternal Identifier associated with this elementXMLJSON
indirectTargettarget if different from the subject.XMLJSON
iso21090-AD-useBAD | CONF | HP | HV | DIR | PUB | PHYS | PSTXMLJSON
iso21090-ADXP-additionalLocatoradditionalLocatorXMLJSON
iso21090-ADXP-buildingNumberSuffixbuildingNumberSuffixXMLJSON
iso21090-ADXP-careOfcareOfXMLJSON
iso21090-ADXP-censusTractcensusTractXMLJSON
iso21090-ADXP-countycountyXMLJSON
iso21090-ADXP-delimiterdelimiterXMLJSON
iso21090-ADXP-deliveryAddressLinedeliveryAddressLineXMLJSON
iso21090-ADXP-deliveryInstallationAreadeliveryInstallationAreaXMLJSON
iso21090-ADXP-deliveryInstallationQualifierdeliveryInstallationQualifierXMLJSON
iso21090-ADXP-deliveryInstallationTypedeliveryInstallationTypeXMLJSON
iso21090-ADXP-deliveryModedeliveryModeXMLJSON
iso21090-ADXP-deliveryModeIdentifierdeliveryModeIdentifierXMLJSON
iso21090-ADXP-directiondirectionXMLJSON
iso21090-ADXP-houseNumberhouseNumberXMLJSON
iso21090-ADXP-houseNumberNumerichouseNumberNumericXMLJSON
iso21090-ADXP-postBoxpostBoxXMLJSON
iso21090-ADXP-precinctprecinctXMLJSON
iso21090-ADXP-streetAddressLinestreetAddressLineXMLJSON
iso21090-ADXP-streetNamestreetNameXMLJSON
iso21090-ADXP-streetNameBasestreetNameBaseXMLJSON
iso21090-ADXP-streetNameTypestreetNameTypeXMLJSON
iso21090-ADXP-unitIDunitIDXMLJSON
iso21090-ADXP-unitTypeunitTypeXMLJSON
iso21090-EN-qualifierLS | AC | NB | PR | HON | BR | AD | SP | MID | CL | INXMLJSON
iso21090-SC-codingcode for stringXMLJSON
iso21090-ST-languagelanguageXMLJSON
iso21090-ST-translationtranslationXMLJSON
iso21090-nullFlavorNI | OTH | NINF | PINF | UNK | ASKU | NAV | NASK | TRC | MSK | NA | QSXMLJSON
iso21090-preferredpreferredXMLJSON
iso21090-uncertaintyStandard Deviation (same units as the quantity)XMLJSON
iso21090-uncertaintyTypeProbability Distribution Type for uncertaintyXMLJSON
iso21090-verificationverificationXMLJSON
ldl-chol-calculatedLDL is CalculatedXMLJSON
markupString equivalent with html markupXMLJSON
maxDecimalPlacesMaximum digits after decimalXMLJSON
maxLengthNo more than this many charactersXMLJSON
maxSizeMax size in MBXMLJSON
maxValueMust be <= this valueXMLJSON
medication-isActiveIngredientIs Active Ingredient FlagXMLJSON
medication-usualRouteUsual RouteXMLJSON
medicationdispense-doseTypeDose TypeXMLJSON
medicationdispense-infuseOverInfuse OverXMLJSON
medicationdispense-maxDeliveryRateMaximum Delivery RateXMLJSON
medicationdispense-maxDeliveryVolumeMaximum Delivery VolumeXMLJSON
medicationdispense-minDosePerPeriodMinimum Dose per PeriodXMLJSON
medicationdispense-rateGoalRate GoalXMLJSON
medicationdispense-rateIncrementRate IncrementXMLJSON
medicationdispense-rateIncrementIntervalRate Increment IntervalXMLJSON
medicationprescription-doseTypeDose TypeXMLJSON
medicationprescription-infuseOverInfuse OverXMLJSON
medicationprescription-maxDeliveryRateMaximum Delivery RateXMLJSON
medicationprescription-maxDeliveryVolumeMaximum Delivery VolumeXMLJSON
medicationprescription-minDosePerPeriodMinimum Dose per PeriodXMLJSON
medicationprescription-rateGoalRate GoalXMLJSON
medicationprescription-rateIncrementRate IncrementXMLJSON
medicationprescription-rateIncrementIntervalRate Increment IntervalXMLJSON
medicationprescription-specialDosingSpecial DosingXMLJSON
mimeTypeType of attachmentXMLJSON
minLengthAt least this many charactersXMLJSON
minValueMust be >= this valueXMLJSON
openEHR-administrationActual medication record, if knownXMLJSON
openEHR-careplanClinical Management DetailsXMLJSON
openEHR-exposureDateDate(/time) of first exposure to SubstanceXMLJSON
openEHR-exposureDescriptionText description about exposure to the SubstanceXMLJSON
openEHR-exposureDurationAmount of time individual was exposed to SubstanceXMLJSON
openEHR-locationBody site of manifestationsXMLJSON
openEHR-managementClinical Management DescriptionXMLJSON
openEHR-testObservations that confirm or refuteXMLJSON
operationoutcome-issue-sourceSource of a validation messageXMLJSON
patient-adoptionInfoAdoption InformationXMLJSON
patient-birthPlaceBirthplaceXMLJSON
patient-cadavericDonorCadaveric DonorXMLJSON
patient-citizenshipCitizenshipXMLJSON
patient-citizenshipCodeCitizenship CodeXMLJSON
patient-citizenshipPeriodCitizenship PeriodXMLJSON
patient-congregationCongregationXMLJSON
patient-disabilityDisability CodeXMLJSON
patient-ethnicityEthnicityXMLJSON
patient-hspc-communicationModeCommunication ModeXMLJSON
patient-hspc-importanceImportanceXMLJSON
patient-mothers-maiden-nameMother's Maiden nameXMLJSON
patient-mothersMaidenNameMother's Maiden nameXMLJSON
patient-nationalityNationalityXMLJSON
patient-nationalityCodeNationality CodeXMLJSON
patient-nationalityPeriodNationality PeriodXMLJSON
patient-raceRaceXMLJSON
patient-religionReligionXMLJSON
patient-veteranMilitaryStatusVeteran Military StatusXMLJSON
practitioner-administrativeAffiliationAdministrative AffiliationXMLJSON
practitioner-classificationClassificationXMLJSON
practitioner-credentialStatusCredential StatusXMLJSON
practitioner-practiceAffiliationPractice AffiliationXMLJSON
practitioner-subTypeQualification Sub-TypeXMLJSON
procedure-methodProcedure MethodXMLJSON
procedure-request-methodProcedure MethodXMLJSON
procedure-request-originationModeOrigination ModeXMLJSON
procedure-request-priorityPriorityXMLJSON
profile-display-hintHinting information for the narrative generatorXMLJSON
profile-template-statusTemplate Status Code (more authoring statuses)XMLJSON
provenanceMost recent changeXMLJSON
provenance-hspc-attribution-actionMethodAction MethodXMLJSON
provenance-hspc-attribution-attributionCodeAttribution CodeXMLJSON
provenance-hspc-attribution-individualPersonIndividual PersonXMLJSON
provenance-hspc-attribution-patientLocationPatient LocationXMLJSON
provenance-hspc-attribution-providerLocationProvider LocationXMLJSON
questionnaire-allowedResourceAllowed resource for referenceXMLJSON
questionnaire-categoryWhat kind of questionnaire?XMLJSON
questionnaire-deReferenceImplemented CDEXMLJSON
questionnaire-defaultAsFixedTreat default as fixed value?XMLJSON
questionnaire-defaultValueInitial presumed answer for questionXMLJSON
questionnaire-enableWhenOnly allow data when:XMLJSON
questionnaire-helpText to display if help incoked on group/questionXMLJSON
questionnaire-hiddenDon't display to userXMLJSON
questionnaire-instructionHow to populate group or questionXMLJSON
questionnaire-labelE.g. "1(a)", "2.5.3"XMLJSON
questionnaire-maxOccursMaximum repetitionsXMLJSON
questionnaire-minOccursMinimum repetitionsXMLJSON
questionnaire-sdc-endpointWhere to send answersXMLJSON
questionnaire-sdc-optionalDisplayCan suppress from display to userXMLJSON
questionnaire-sdc-specialGroupheader | footerXMLJSON
questionnaire-securitySecurity/privacy rules governing group/questionXMLJSON
questionnaire-tooltipFly-over or equivalent textXMLJSON
questionnaire-trailingText to display after group/question contentXMLJSON
questionnaire-unitsUnit of measure for questionXMLJSON
regexRegular expression patternXMLJSON
relatedDeviceMetricReference to the DeviceMetric resourceXMLJSON
securityevent-ehrs-rle-locationWhere the activity occurred, if relevantXMLJSON
securityevent-ehrs-rle-policyPolicy or plan th eactivity was defined byXMLJSON
securityevent-ehrs-rle-reasonReason activity is occurringXMLJSON
specimen-collectionPriorityCollection PriorityXMLJSON
styleHtml style valueXMLJSON
styleSensitiveAre styles important for processing?XMLJSON
us-core-concernStatusThe status of a Concern associated with a conditionXMLJSON
us-core-countyName of countyXMLJSON
us-core-directEmail is a "direct" emailXMLJSON
us-core-ethnicityA category of human sharing heritageXMLJSON
us-core-raceA category of humans sharing history, origin or nationalityXMLJSON
us-core-religionPatient's professed religious affiliationXMLJSON
uslabcc-practitionerCopy to practitionerXMLJSON
uslabobservationkindKind of observationXMLJSON
uslabspecimenrejectreasonSpecimen Rejection ReasonXMLJSON
valueset-authorUser or Org actually involved in creating the value set contentXMLJSON
valueset-caseSensitiveIf code is case sensitiveXMLJSON
valueset-categoryKind of value setXMLJSON
valueset-commentHuman-specified notes and other documentationXMLJSON
valueset-commentsComment about the use of this code in this contextXMLJSON
valueset-conceptOrderAppearance order for user selectionXMLJSON
valueset-definitionA definition for this codeXMLJSON
valueset-deprecatedWhether the concept has been deprecatedXMLJSON
valueset-displayDisplay value for the codeXMLJSON
valueset-effectiveDateWhen the value set version becomes Active and is available for useXMLJSON
valueset-expirationDateWhen the value set version should no longer be usedXMLJSON
valueset-historyWhat has happened over timeXMLJSON
valueset-keyWordDescriptors and key terms for searchXMLJSON
valueset-labelE.g. "(a)", "1.", etc.XMLJSON
valueset-oidOID assigned to the value set or code systemXMLJSON
valueset-ordinalValueComparison value for ordinal codesXMLJSON
valueset-otherNameAlternative namesXMLJSON
valueset-sourceReferenceWhere did this content come fromXMLJSON
valueset-subsumesCodes that this concept subsumes that have already been declared elsewhereXMLJSON
valueset-systemNameCode system nameXMLJSON
valueset-systemRefWhere to find code systemXMLJSON
valueset-trusted-expansionReference to a trusted expansionXMLJSON
valueset-usageWho has used and how?XMLJSON
valueset-workflowStatusIndicates the state of development of the value setXMLJSON
xds-author-institution-repeatsAdditional InstitutionsXMLJSON
xds-practiceSettingCodeXDSDocumentEntry.practiceSettingCodeXMLJSON

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.