HEARTLAND Protocol

HEARTLAND Protocol FHIR Implementation Guide
0.3.0 - United States of America flag

HEARTLAND FHIR candidate 0.3.0 — draft, experimental R4 4.0.1 reference. Prepared for technical review; not evidence of clinical validation or vendor interoperability.

Resource Profile: HEARTLAND Patient ( Experimental )

Official URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-patient Version: 0.3.0
Draft as of 2026-09-29 Computable Name: HeartlandPatient

Patient profile carrying HEARTLAND-specific extensions used by the risk score: distance to cardiology and social support status. Constrains the base FHIR R4 Patient resource for use within HEARTLAND Protocol v3.2 workflows.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... address
.... Slices for extension Content/Rules for all slices
..... extension:syntheticCountyCode 0..1 Coding HEARTLAND Synthetic County Identifier
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-synthetic-county-code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier An identifier for this patient
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:syntheticCountyCode 0..1 Coding HEARTLAND Synthetic County Identifier
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-synthetic-county-code
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... address
.... Slices for extension Content/Rules for all slices
..... extension:syntheticCountyCode 0..1 Coding HEARTLAND Synthetic County Identifier
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-synthetic-county-code

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:distanceToCardiology S 0..1 Quantity HEARTLAND Distance to Cardiology
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-distance-to-cardiology
.... extension:socialSupportScore S 0..1 boolean HEARTLAND Social Support Score
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-social-support-score
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier An identifier for this patient
... active ?!Σ 0..1 boolean Whether this patient's record is in active use
... name Σ 0..* HumanName A name associated with the patient
... telecom Σ 0..* ContactPoint A contact detail for the individual
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date of birth for the individual
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address Σ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:syntheticCountyCode 0..1 Coding HEARTLAND Synthetic County Identifier
URL: https://fhir.heartlandprotocol.org/StructureDefinition/heartland-synthetic-county-code
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.maritalStatus Base extensible MaritalStatus 📍4.0.1 FHIR Std.
Patient.contact.relationship Base extensible Patient Contact Relationship 📍4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

 

Other representations of profile: CSV, Excel, Schematron