Case Based Surveillance Implementation Guide
0.1.0 - ci-build

Case Based Surveillance Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: Case Based Surveillance Patient Profile

Defining URL:http://cbsig.chai.gatech.edu/StructureDefinition/cbs-patient
Version:0.1.0
Name:CaseBasedSurveillancePatient
Title:Case Based Surveillance Patient Profile
Status:Experimental as of 1/1/21
Definition:

Defines constraints and extensions to the patient resource in order to meet the needs of public health surveillance programs while providing as much alignment with US Core requirements as possible. Mapping between similar concepts implemented with different value sets (ie: race, ethnicity, or sex assigned at birth) may be required.

Publisher:Georgia Tech Research Institute (GTRI)
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://cbsig.chai.gatech.edu/StructureDefinition/cbs-patient

Mandatory and Must Support Data Elements

The following data-elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements. The “Snapshot Table (Must Support)” tab below displays all the mandatory and must support data elements for this profile.

Each Patient must have:

  1. An identifier

Each Patient must support:

  1. a name
  2. a gender
  3. a birth date
  4. whether the patient is deceased or when the patient died
  5. an address

Additional Case Based Surveillance Requirements To meet the requirements of case based surveillance programs, the following additional elements must be supported. These elements are based on needs established from the CDC Message Mapping Guides.

  1. a race
  2. an ethnicity
  3. a birth place
  4. a sex assigned at birth
  5. a gender identity
  6. a census tract location
  7. additional Address.use codes through the Address Use extension

Address Use Description Case based surveillance programs may require more explicit address labeling than is present in the standard Address Use valueset. Due to the required binding of the Address.use element, additional values are provided as part of the “CDC Address Use” extension. Please note that the “CDC” labeling here only specifies the source of the values, and is not indicative of CDC endorsement.

Address Use Requirements and Guidance

  1. The Address.use element and the Address Use extension SHALL NOT be provided simultaneously.
  2. For common patient addresses requested by a program, including census tract designations, the Address Use extension SHALL NOT be used, and the Address.use SHALL be set to “home”.
  3. Any adddress provided utilizing the Address Use extension SHALL align with the purpose of an address requested by a surveillance program as specified on a program by program basis.
  4. In a case in which multiple addresses are requested which are at the time of request the same address values,the address SHALL be recorded as multiple distinct addresses with the Address.use or Address Use extension set appropriately. Example: If a program requests an address at time of diagnosis that is the same as the patient’s current address, the address shall be provided twice. Once with the Address.use set to “home” and again with the Address Use extension set to “Address at Diagnosis of Condition”. This maintains the address at diagnosis as a snapshot such that the primary address can be updated in accordance with standard FHIR resource handling.

Formal Views of Profile Content

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

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-race S0..1(Complex)CBS Race Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
... cbs-ethnicity S0..1(Complex)CBS Ethnicity Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
... patient-genderIdentity S0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (STD) (extensible)
... patient-birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... identifier S1..*IdentifierAn identifier for this patient
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique within the system.
... name S0..*HumanNameA name associated with the patient
... gender S0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] S0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S0..*AddressAn address for the individual
.... cbs-cdc-address-use S0..1CodingCase Based Surveillance CDC Address Use Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-cdc-address-use
Binding: Additional codes for Address.use. (required): Code for Address Use

.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090-ADXP-censusTract S0..1stringcensusTract
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period S0..1PeriodTime period when address was/is in use

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-race S0..1(Complex)CBS Race Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
... cbs-ethnicity S0..1(Complex)CBS Ethnicity Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
... cbs-birthsex S0..1codeCase Based Surveillance Sex Assigned at Birth Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-birthsex
Binding: Sex (MFU) (required): Code for sex assigned at birth


... patient-genderIdentity S0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (STD) (extensible)
... patient-birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cbs-cdc-address-use S0..1CodingCase Based Surveillance CDC Address Use Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-cdc-address-use
Binding: Additional codes for Address.use. (required): Code for Address Use


.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090-ADXP-censusTract S0..1stringcensusTract
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... cbs-race 0..1(Complex)CBS Race Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
... cbs-ethnicity 0..1(Complex)CBS Ethnicity Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
... cbs-birthsex 0..1codeCase Based Surveillance Sex Assigned at Birth Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-birthsex
Binding: Sex (MFU) (required): Code for sex assigned at birth


... patient-birthPlace 0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... identifier Σ1..*IdentifierAn identifier for this patient
.... system Σ1..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique within the system.
... name Σ0..*HumanNameA name associated with the patient
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date of birth for the individual
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAn address for the individual
.... cbs-cdc-address-use 0..1CodingCase Based Surveillance CDC Address Use Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-cdc-address-use
Binding: Additional codes for Address.use. (required): Code for Address Use


.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
..... iso21090-ADXP-censusTract 0..1stringcensusTract
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... city Σ0..1stringName of city, town etc.
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringUS Zip Codes
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use

doco Documentation for this format

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-race S0..1(Complex)CBS Race Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
... cbs-ethnicity S0..1(Complex)CBS Ethnicity Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
... patient-genderIdentity S0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (STD) (extensible)
... patient-birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... identifier S1..*IdentifierAn identifier for this patient
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique within the system.
... name S0..*HumanNameA name associated with the patient
... gender S0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate S0..1dateThe date of birth for the individual
... deceased[x] S0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S0..*AddressAn address for the individual
.... cbs-cdc-address-use S0..1CodingCase Based Surveillance CDC Address Use Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-cdc-address-use
Binding: Additional codes for Address.use. (required): Code for Address Use

.... use S0..1codehome | work | temp | old | billing - purpose of this address
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090-ADXP-censusTract S0..1stringcensusTract
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
.... city S0..1stringName of city, town etc.
.... state S0..1stringSub-unit of country (abbreviations ok)
.... postalCode S0..1stringUS Zip Codes
.... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period S0..1PeriodTime period when address was/is in use

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientInformation about an individual or animal receiving health care services
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... cbs-race S0..1(Complex)CBS Race Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-race
... cbs-ethnicity S0..1(Complex)CBS Ethnicity Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-ethnicity
... cbs-birthsex S0..1codeCase Based Surveillance Sex Assigned at Birth Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-birthsex
Binding: Sex (MFU) (required): Code for sex assigned at birth


... patient-genderIdentity S0..1CodeableConceptThe patient's gender identity
URL: http://hl7.org/fhir/StructureDefinition/patient-genderIdentity
Binding: GenderIdentity (example)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Gender Identity (STD) (extensible)
... patient-birthPlace S0..1AddressPlace of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierAn identifier for this patient
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ0..*HumanNameA name associated with the patient
... telecom Σ0..*ContactPointA contact detail for the individual
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateThe date of birth for the individual
... deceased[x] ?!SΣ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressAn address for the individual
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... cbs-cdc-address-use S0..1CodingCase Based Surveillance CDC Address Use Extension
URL: http://cbsig.chai.gatech.edu/StructureDefinition/cbs-cdc-address-use
Binding: Additional codes for Address.use. (required): Code for Address Use


.... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... iso21090-ADXP-censusTract S0..1stringcensusTract
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-censusTract
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.

... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization I0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Patient.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.extension:genderIdentity.value[x]extensiblePHVS_GenderIdentity_STD
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typeextensibleIdentifier Type Codes
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.maritalStatusextensibleMarital Status Codes
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages
Patient.link.typerequiredLinkType

Constraints

IdGradePathDetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorPatient.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.extension:raceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension:raceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.extension:ethnicityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension:ethnicityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.extension:birthsexAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension:birthsexMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.extension:genderIdentityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension:genderIdentityMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.extension:genderIdentity.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.extension:birthPlaceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.extension:birthPlaceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.deceased[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.address.extension:cbs-cdc-address-useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.address.extension:cbs-cdc-address-useMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.address.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.line.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.address.line.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.address.line.extension:censusTractAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.address.line.extension:censusTractMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.address.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.address.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.maritalStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.multipleBirth[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()
ele-1errorPatient.contact.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.contact.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.contact.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.contact.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.contact.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.contact.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.generalPractitionerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorPatient.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorPatient.link.otherAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorPatient.link.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())