US Core Implementation Guide
7.0.0-ballot - STU6 United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Extension: US Core Jurisdiction Extension

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-jurisdiction Version: 7.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: USCoreJurisdictionExtension

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

An extension to communicate the US state or local jurisdiction for individual and entity identifiers. For example, a practitioner’s state or local jurisdiction for a license.

Context of Use

This extension may be used on the following element(s):

  • Element ID Patient.identifier
  • Element ID Patient.contact.organization.identifier
  • Element ID Patient.generalPractitioner.identifier
  • Element ID Patient.managingOrganization.identifier
  • Element ID Patient.link.other.identifier
  • Element ID Practitioner.identifier
  • Element ID Practitioner.qualification.identifier
  • Element ID Practitioner.qualification.issuer.identifier
  • Element ID PractitionerRole.identifier
  • Element ID PractitionerRole.practitioner.identifier
  • Element ID PractitionerRole.organization.identifier
  • Element ID PractitionerRole.location.identifier
  • Element ID PractitionerRole.healthcareService.identifier
  • Element ID PractitionerRole.endpoint.identifier
  • Element ID RelatedPerson.identifier
  • Element ID RelatedPerson.patient.identifier
  • Element ID Person.identifier
  • Element ID Person.managingOrganization.identifier
  • Element ID Person.link.target.identifier
  • Element ID Group.identifier
  • Element ID Group.managingEntity.identifier
  • Element ID Group.characteristic.value[x].identifier
  • Element ID Group.member.entity.identifier
  • Element ID Organization.identifier
  • Element ID Organization.partOf.identifier
  • Element ID Organization.endpoint.identifier
  • Element ID OrganizationAffiliation.identifier
  • Element ID OrganizationAffiliation.organization.identifier
  • Element ID OrganizationAffiliation.participatingOrganization.identifier
  • Element ID OrganizationAffiliation.network.identifier
  • Element ID OrganizationAffiliation.location.identifier
  • Element ID OrganizationAffiliation.healthcareService.identifier
  • Element ID OrganizationAffiliation.endpoint.identifier
  • Element ID HealthcareService.identifier
  • Element ID HealthcareService.providedBy.identifier
  • Element ID HealthcareService.location.identifier
  • Element ID HealthcareService.coverageArea.identifier
  • Element ID HealthcareService.endpoint.identifier
  • Element ID Endpoint.identifier
  • Element ID Endpoint.managingOrganization.identifier
  • Element ID Location.identifier
  • Element ID Location.managingOrganization.identifier
  • Element ID Location.partOf.identifier
  • Element ID Location.endpoint.identifier
  • Element ID Substance.identifier
  • Element ID Substance.instance.identifier
  • Element ID Substance.ingredient.substance[x].identifier
  • Element ID BiologicallyDerivedProduct.identifier
  • Element ID BiologicallyDerivedProduct.request.identifier
  • Element ID BiologicallyDerivedProduct.parent.identifier
  • Element ID BiologicallyDerivedProduct.collection.collector.identifier
  • Element ID BiologicallyDerivedProduct.collection.source.identifier
  • Element ID BiologicallyDerivedProduct.processing.additive.identifier
  • Element ID Device.identifier
  • Element ID Device.definition.identifier
  • Element ID Device.version.component
  • Element ID Device.patient.identifier
  • Element ID Device.owner.identifier
  • Element ID Device.location.identifier
  • Element ID Device.parent.identifier
  • Element ID Specimen.identifier
  • Element ID Specimen.accessionIdentifier
  • Element ID Specimen.subject.identifier
  • Element ID Specimen.parent.identifier
  • Element ID Specimen.request.identifier
  • Element ID Specimen.collection.collector.identifier
  • Element ID Specimen.processing.additive.identifier
  • Element ID Specimen.container.identifier
  • Element ID Specimen.container.additive[x].identifier
  • Element ID BodyStructure.identifier
  • Element ID BodyStructure.patient.identifier
  • Element ID Coverage.identifier
  • Element ID Coverage.policyHolder.identifier
  • Element ID Coverage.subscriber.identifier
  • Element ID Coverage.beneficiary.identifier
  • Element ID Coverage.payor.identifier
  • Element ID Coverage.contract.identifier
  • Element ID Claim.identifier
  • Element ID Claim.patient.identifier
  • Element ID Claim.enterer.identifier
  • Element ID Claim.insurer.identifier
  • Element ID Claim.provider.identifier
  • Element ID Claim.related.claim.identifier
  • Element ID Claim.related.reference
  • Element ID Claim.prescription.identifier
  • Element ID Claim.originalPrescription.identifier
  • Element ID Claim.payee.party.identifier
  • Element ID Claim.referral.identifier
  • Element ID Claim.facility.identifier
  • Element ID Claim.careTeam.provider.identifier
  • Element ID Claim.supportingInfo.value[x].identifier
  • Element ID Claim.diagnosis.diagnosis[x].identifier
  • Element ID Claim.procedure.procedure[x].identifier
  • Element ID Claim.procedure.udi.identifier
  • Element ID Claim.insurance.identifier
  • Element ID Claim.insurance.coverage.identifier
  • Element ID Claim.insurance.claimResponse.identifier
  • Element ID Claim.accident.location[x].identifier
  • Element ID Claim.item.location[x].identifier
  • Element ID Claim.item.udi.identifier
  • Element ID Claim.item.encounter.identifier
  • Element ID Claim.item.detail.udi.identifier
  • Element ID Claim.item.detail.subDetail.udi.identifier
  • Element ID Invoice.identifier
  • Element ID Invoice.subject.identifier
  • Element ID Invoice.recipient.identifier
  • Element ID Invoice.participant.actor.identifier
  • Element ID Invoice.issuer.identifier
  • Element ID Invoice.account.identifier
  • Element ID Invoice.lineItem.chargeItem[x].identifier
  • Element ID Contract.identifier
  • Element ID Contract.instantiatesCanonical.identifier
  • Element ID Contract.subject.identifier
  • Element ID Contract.authority.identifier
  • Element ID Contract.domain.identifier
  • Element ID Contract.site.identifier
  • Element ID Contract.author.identifier
  • Element ID Contract.topic[x].identifier
  • Element ID Contract.contentDefinition.publisher.identifier
  • Element ID Contract.term.identifier
  • Element ID Contract.term.topic[x].identifier
  • Element ID Contract.term.offer.identifier
  • Element ID Contract.term.offer.party.reference.identifier
  • Element ID Contract.term.offer.topic.identifier
  • Element ID Contract.term.offer.answer.value[x].identifier
  • Element ID Contract.term.asset.typeReference.identifier
  • Element ID Contract.term.asset.context.reference.identifier
  • Element ID Contract.term.asset.valuedItem.entity[x].identifier
  • Element ID Contract.term.asset.valuedItem.identifier
  • Element ID Contract.term.asset.valuedItem.responsible.identifier
  • Element ID Contract.term.asset.valuedItem.recipient.identifier
  • Element ID Contract.term.action.subject.reference.identifier
  • Element ID Contract.term.action.context.identifier
  • Element ID Contract.term.action.requester.identifier
  • Element ID Contract.term.action.performer.identifier
  • Element ID Contract.term.action.reasonReference.identifier
  • Element ID Contract.supportingInfo.identifier
  • Element ID Contract.relevantHistory.identifier
  • Element ID Contract.signer.party.identifier
  • Element ID Contract.friendly.content[x].identifier
  • Element ID Contract.legal.content[x].identifier
  • Element ID Contract.rule.content[x].identifier
  • Element ID Contract.legallyBinding[x].identifier
  • Element ID ExplanationOfBenefit.identifier
  • Element ID ExplanationOfBenefit.patient.identifier
  • Element ID ExplanationOfBenefit.enterer.identifier
  • Element ID ExplanationOfBenefit.insurer.identifier
  • Element ID ExplanationOfBenefit.provider.identifier
  • Element ID ExplanationOfBenefit.related.claim.identifier
  • Element ID ExplanationOfBenefit.related.reference
  • Element ID ExplanationOfBenefit.prescription.identifier
  • Element ID ExplanationOfBenefit.originalPrescription.identifier
  • Element ID ExplanationOfBenefit.payee.party.identifier
  • Element ID ExplanationOfBenefit.referral.identifier
  • Element ID ExplanationOfBenefit.facility.identifier
  • Element ID ExplanationOfBenefit.claim.identifier
  • Element ID ExplanationOfBenefit.claimResponse.identifier
  • Element ID ExplanationOfBenefit.careTeam.provider.identifier
  • Element ID ExplanationOfBenefit.supportingInfo.value[x].identifier
  • Element ID ExplanationOfBenefit.diagnosis.diagnosis[x].identifier
  • Element ID ExplanationOfBenefit.procedure.procedure[x].identifier
  • Element ID ExplanationOfBenefit.procedure.udi.identifier
  • Element ID ExplanationOfBenefit.insurance.coverage.identifier
  • Element ID ExplanationOfBenefit.accident.location[x].identifier
  • Element ID ExplanationOfBenefit.item.location[x].identifier
  • Element ID ExplanationOfBenefit.item.udi.identifier
  • Element ID ExplanationOfBenefit.item.encounter.identifier
  • Element ID ExplanationOfBenefit.item.detail.udi.identifier
  • Element ID ExplanationOfBenefit.item.detail.subDetail.udi.identifier
  • Element ID ExplanationOfBenefit.addItem.provider.identifier
  • Element ID ExplanationOfBenefit.addItem.location[x].identifier
  • Element ID ExplanationOfBenefit.payment.identifier
  • Element ID InsurancePlan.identifier
  • Element ID InsurancePlan.ownedBy.identifier
  • Element ID InsurancePlan.administeredBy.identifier
  • Element ID InsurancePlan.coverageArea.identifier
  • Element ID InsurancePlan.endpoint.identifier
  • Element ID InsurancePlan.network.identifier
  • Element ID InsurancePlan.coverage.network.identifier
  • Element ID InsurancePlan.plan.identifier
  • Element ID InsurancePlan.plan.coverageArea.identifier
  • Element ID InsurancePlan.plan.network.identifier
  • Element ID DeviceMetric.identifier
  • Element ID DeviceMetric.source.identifier
  • Element ID DeviceMetric.parent.identifier
  • Element ID Consent.identifier
  • Element ID Consent.patient.identifier
  • Element ID Consent.performer.identifier
  • Element ID Consent.organization.identifier
  • Element ID Consent.source[x].identifier
  • Element ID Consent.verification.verifiedWith.identifier
  • Element ID Consent.provision.actor.reference.identifier
  • Element ID Consent.provision.data.reference.identifier

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Simple Extension of type CodeableConcept: An extension to communicate the US state or local jurisdiction for individual and entity identifiers. For example, a practitioner's state or local jurisdiction for a license.

Maturity: 3

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS State or local jurisdiction
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-jurisdiction"
... value[x] 1..1CodeableConceptValue of extension
Binding: USPS Two Letter Alphabetic Codes (extensible): Target US State or local jurisdiction.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS State or local jurisdiction
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-jurisdiction"
... value[x] 1..1CodeableConceptValue of extension
Binding: USPS Two Letter Alphabetic Codes (extensible): Target US State or local jurisdiction.


doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type CodeableConcept: An extension to communicate the US state or local jurisdiction for individual and entity identifiers. For example, a practitioner's state or local jurisdiction for a license.

Maturity: 3

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS State or local jurisdiction
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-jurisdiction"
... value[x] 1..1CodeableConceptValue of extension
Binding: USPS Two Letter Alphabetic Codes (extensible): Target US State or local jurisdiction.


doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionUS State or local jurisdiction
... id 0..1stringUnique id for inter-element referencing
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/us/core/StructureDefinition/us-core-jurisdiction"
... value[x] 1..1CodeableConceptValue of extension
Binding: USPS Two Letter Alphabetic Codes (extensible): Target US State or local jurisdiction.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.value[x]extensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()