minimal Common Oncology Data Elements (mCODE) Implementation Guide
4.0.0-ballot - STU4 Ballot United States of America flag

minimal Common Oncology Data Elements (mCODE) Implementation Guide, published by HL7 International / Clinical Interoperability Council. This guide is not an authorized publication; it is the continuous build for version 4.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/fhir-mCODE-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Cancer Patient Profile

Official URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-cancer-patient Version: 4.0.0-ballot
Active as of 2024-04-09 Maturity Level: 5 Computable Name: CancerPatient
Other Identifiers: OID:2.16.840.1.113883.4.642.40.15.42.7

A patient who has been diagnosed with or is receiving medical treatment for a malignant growth or tumor. The only difference between CancerPatient and US Core Patient is that Patient.deceased is a must-support element in mCODE. Must-support is an instruction to implementers of FHIR clients and servers, rather than a constraint on data structure. Any Patient resource complying with US Core Patient Profile will also comply with CancerPatient.

Conformance

Patient resources representing Cancer Patients in the scope of mCODE (as defined on the Identifying in-scope Patients page) SHALL conform to this profile. Any resource intended to conform to this profile SHOULD populate meta.profile accordingly.

Usage:

Changes since version true:

  • No changes

    • Formal Views of Profile Content

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

    This structure is derived from USCorePatientProfile

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient S 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    ... extension:birthsex S 0..1 USCoreBirthSexExtension Extension
    ... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient SC 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SΣ 1..* Identifier An identifier for this patient
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    ... active ?!Σ 0..1 boolean Whether this patient's record is in active use
    ... name SΣ 1..* HumanName A name associated with the patient
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... family SΣC 0..1 string Family name (often called 'Surname')
    .... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ... telecom Σ 0..* ContactPoint A contact detail for the individual
    .... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

    .... value SΣ 1..1 string The actual contact point details
    .... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required)
    ... gender SΣ 1..1 code male | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ 0..1 date The date of birth for the individual
    ... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    ... address SΣ 0..* Address An address for the individual
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


    Example General: home
    .... line SΣ 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 SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    .... period SΣ 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    ... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    ... 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

    PathConformanceValueSetURI
    Patient.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Patient.telecom.systemrequiredContactPointSystem
    http://hl7.org/fhir/ValueSet/contact-point-system
    from the FHIR Standard
    Patient.telecom.userequiredContactPointUse
    http://hl7.org/fhir/ValueSet/contact-point-use
    from the FHIR Standard
    Patient.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender
    from the FHIR Standard
    Patient.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
    http://hl7.org/fhir/us/core/ValueSet/simple-language
    Patient.link.typerequiredLinkType
    http://hl7.org/fhir/ValueSet/link-type|4.0.1
    from the FHIR Standard
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient SC 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
    ... 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
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... birthsex S 0..1 code Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required): Code for sex assigned at birth


    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SΣ 1..* Identifier An identifier for this patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... active ?!Σ 0..1 boolean Whether this patient's record is in active use
    ... name SΣ 1..* HumanName A name associated with the patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... text Σ 0..1 string Text representation of the full name
    .... family SΣC 0..1 string Family name (often called 'Surname')
    .... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom Σ 0..* ContactPoint A contact detail for the individual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

    .... value SΣ 1..1 string The actual contact point details
    .... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required)
    .... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
    .... period Σ 0..1 Period Time period when the contact point was/is in use
    ... gender SΣ 1..1 code male | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ 0..1 date The date of birth for the individual
    ... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    ... address SΣ 0..* Address An address for the individual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... 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 SΣ 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 SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    .... district Σ 0..1 string District name (aka county)
    Example General: Madison
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    .... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    .... period SΣ 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
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... 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 S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    .... 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

    PathConformanceValueSetURI
    Patient.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Patient.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Patient.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Patient.telecom.systemrequiredContactPointSystem
    http://hl7.org/fhir/ValueSet/contact-point-system
    from the FHIR Standard
    Patient.telecom.userequiredContactPointUse
    http://hl7.org/fhir/ValueSet/contact-point-use
    from the FHIR Standard
    Patient.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender
    from the FHIR Standard
    Patient.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Patient.address.typerequiredAddressType
    http://hl7.org/fhir/ValueSet/address-type|4.0.1
    from the FHIR Standard
    Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    Patient.maritalStatusextensibleMarital Status Codes
    http://hl7.org/fhir/ValueSet/marital-status
    from the FHIR Standard
    Patient.contact.relationshipextensiblePatientContactRelationship
    http://hl7.org/fhir/ValueSet/patient-contactrelationship
    from the FHIR Standard
    Patient.contact.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
    http://hl7.org/fhir/us/core/ValueSet/simple-language
    Patient.link.typerequiredLinkType
    http://hl7.org/fhir/ValueSet/link-type|4.0.1
    from the FHIR Standard

    This structure is derived from USCorePatientProfile

    Summary

    Must-Support: 2 elements

    Maturity: 5

    Differential View

    This structure is derived from USCorePatientProfile

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient S 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    ... extension:birthsex S 0..1 USCoreBirthSexExtension Extension
    ... deceased[x] S 0..1 boolean, dateTime Indicates if the individual is deceased or not

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient SC 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SΣ 1..* Identifier An identifier for this patient
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... system SΣ 1..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    ... active ?!Σ 0..1 boolean Whether this patient's record is in active use
    ... name SΣ 1..* HumanName A name associated with the patient
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... family SΣC 0..1 string Family name (often called 'Surname')
    .... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    ... telecom Σ 0..* ContactPoint A contact detail for the individual
    .... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

    .... value SΣ 1..1 string The actual contact point details
    .... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required)
    ... gender SΣ 1..1 code male | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ 0..1 date The date of birth for the individual
    ... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    ... address SΣ 0..* Address An address for the individual
    .... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
    Binding: AddressUse (required): The use of an address.


    Example General: home
    .... line SΣ 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 SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    .... period SΣ 0..1 Period Time period when address was/is in use
    Example General: {"start":"2010-03-23","end":"2010-07-01"}
    ... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... language S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    ... 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

    PathConformanceValueSetURI
    Patient.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Patient.telecom.systemrequiredContactPointSystem
    http://hl7.org/fhir/ValueSet/contact-point-system
    from the FHIR Standard
    Patient.telecom.userequiredContactPointUse
    http://hl7.org/fhir/ValueSet/contact-point-use
    from the FHIR Standard
    Patient.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender
    from the FHIR Standard
    Patient.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
    http://hl7.org/fhir/us/core/ValueSet/simple-language
    Patient.link.typerequiredLinkType
    http://hl7.org/fhir/ValueSet/link-type|4.0.1
    from the FHIR Standard

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Patient SC 0..* USCorePatientProfile Information about an individual or animal receiving health care services
    us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
    ... 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
    ... language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ... race 0..1 (Complex) US Core Race Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
    ... ethnicity 0..1 (Complex) US Core ethnicity Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
    ... birthsex S 0..1 code Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
    Binding: Birth Sex (required): Code for sex assigned at birth


    ... genderIdentity 0..1 CodeableConcept Extension
    URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
    Binding: Gender Identity . (extensible)
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier SΣ 1..* Identifier An identifier for this patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

    .... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
    Example General: http://www.acme.com/identifiers/patient
    .... value SΣ 1..1 string The value that is unique within the system.
    Example General: 123456
    .... period Σ 0..1 Period Time period when id is/was valid for use
    .... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
    ... active ?!Σ 0..1 boolean Whether this patient's record is in active use
    ... name SΣ 1..* HumanName A name associated with the patient
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... text Σ 0..1 string Text representation of the full name
    .... family SΣC 0..1 string Family name (often called 'Surname')
    .... given SΣC 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom Σ 0..* ContactPoint A contact detail for the individual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
    Binding: ContactPointSystem (required): Telecommunications form for contact point.

    .... value SΣ 1..1 string The actual contact point details
    .... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
    Binding: ContactPointUse (required)
    .... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
    .... period Σ 0..1 Period Time period when the contact point was/is in use
    ... gender SΣ 1..1 code male | female | other | unknown
    Binding: AdministrativeGender (required)
    ... birthDate SΣ 0..1 date The date of birth for the individual
    ... deceased[x] ?!SΣ 0..1 Indicates if the individual is deceased or not
    .... deceasedBoolean boolean
    .... deceasedDateTime dateTime
    ... address SΣ 0..* Address An address for the individual
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... 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 SΣ 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 SΣ 0..1 string Name of city, town etc.
    Example General: Erewhon
    .... district Σ 0..1 string District name (aka county)
    Example General: Madison
    .... state SΣ 0..1 string Sub-unit of country (abbreviations ok)
    Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes.

    .... postalCode SΣ 0..1 string US Zip Codes
    Example General: 9132
    .... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
    .... period SΣ 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
    pat-1: SHALL at least contain a contact's details or a reference to an organization
    .... 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 S 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: Language codes with language and optionally a region modifier (extensible)
    .... 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

    PathConformanceValueSetURI
    Patient.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Patient.identifier.userequiredIdentifierUse
    http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    from the FHIR Standard
    Patient.identifier.typeextensibleIdentifier Type Codes
    http://hl7.org/fhir/ValueSet/identifier-type
    from the FHIR Standard
    Patient.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    Patient.telecom.systemrequiredContactPointSystem
    http://hl7.org/fhir/ValueSet/contact-point-system
    from the FHIR Standard
    Patient.telecom.userequiredContactPointUse
    http://hl7.org/fhir/ValueSet/contact-point-use
    from the FHIR Standard
    Patient.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender
    from the FHIR Standard
    Patient.address.userequiredAddressUse
    http://hl7.org/fhir/ValueSet/address-use|4.0.1
    from the FHIR Standard
    Patient.address.typerequiredAddressType
    http://hl7.org/fhir/ValueSet/address-type|4.0.1
    from the FHIR Standard
    Patient.address.stateextensibleUspsTwoLetterAlphabeticCodes (a valid code from https://www.usps.com/)
    http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
    Patient.maritalStatusextensibleMarital Status Codes
    http://hl7.org/fhir/ValueSet/marital-status
    from the FHIR Standard
    Patient.contact.relationshipextensiblePatientContactRelationship
    http://hl7.org/fhir/ValueSet/patient-contactrelationship
    from the FHIR Standard
    Patient.contact.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
    http://hl7.org/fhir/us/core/ValueSet/simple-language
    Patient.link.typerequiredLinkType
    http://hl7.org/fhir/ValueSet/link-type|4.0.1
    from the FHIR Standard

    This structure is derived from USCorePatientProfile

    Summary

    Must-Support: 2 elements

    Maturity: 5

     

    Other representations of profile: CSV, Excel, Schematron